マークダウンのメモ用のテキストボックスを作成するにはどうすればよいですか?


94

マークダウンでドキュメントを書いています。私は素晴らしいpandocを使用して、マークダウンソースからdocxファイルとtexファイルを作成しています。プログラミングの本と同じように、読者へのヒントやメモ用のテキストボックスが欲しいのですが。マークダウンでこれを行う方法がわかりません。手伝ってくれますか?


Microsoftは、ドキュメントでこれに独自の構文を使用していますが、ご使用の環境では機能しない可能性があります。完全性と以下の回答との比較のためにここに含まれています。github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/...
— brianary

回答:


103

マークダウンテキストにアラートボックス(メモや警告など)を配置するために私が通常行うことは(pandocを使用している場合だけでなく、そのマークダウンがサポートされているすべての場所でも)、コンテンツを2本の水平線で囲んでいます。

---
**NOTE**

It works with almost all markdown flavours (the below blank line matters).

---

これは次のようになります。


注意

すべてのマークダウンフレーバーで機能します(以下の空白行が重要です)。


良い点は、サポートされているマークダウンフレーバーや、インストールまたは有効化されている拡張機能について心配する必要がないことです。

編集:@ filups21がコメントで述べたように、水平線は***RMarkdownで表されているようです。したがって、前述のソリューションは、最初に主張されたように、すべてのマークダウンフレーバーで機能するわけではありません。


4
これは便利ですが、RMarkdown / Rstduio / Knitrでは機能しません
— bjw 2017

2
bjw-rmarkdownの水平線の***前に空白行があります。または、>(空白行が前に付いている)で行を開始して、メモをブロッククォートに入れることもできます。
— filups21 2018年

88

GitHubでは、通常、ブロッククォートを挿入します。

> **_NOTE:_**  The note content.

になる...

注: メモの内容。

もちろん、プレーンHTMLは常に存在します...


@KamilSJaron:え?いいえ、そうではありません。コードブロックについて考えていますか?
— naught1 0118年

@ naught101ああ、私はブロッククォートをバッククォートとして読んでいました。ただし、トリプルバッククォートは実際にはラッピングではありません。
— カミルSジャロン

4
私はこの普遍的な解決策を好みます。また、Unicode絵文字を使用して、> ℹ️ This is an informationまたはなどのメモの接頭辞を付けることも楽しんでいます> ⚠️ This is a warning。
— pierre_loic

1
これとテーブルクラッジは、この質問を移植可能に解決する唯一の答えです。トップの答えによって提案されたハードルールその場しのぎのボックスを表示するには失敗したので、この質問を解決するために失敗しました。実際、この回答と@pierre_loicのUnicodeアイコンmodを組み合わせると、ほとんどがreStructuredTextノートを複製します。
— セシルカレー

16

まったく同じ問題に対して私が見つけた最も簡単な解決策は、1行でヘッダーのない複数行のテーブルを使用することです(最初の列に画像があり、2番目の列にテキストがあります)。

----------------------- ------------------------------------
![Tip](images/tip.png)\ Table multiline text bla bla bla bla
                        bla bla bla bla bla bla bla ... the
                        blank line below is important 

----------------------------------------------------------------

(PDFの場合)機能する可能性のある別のアプローチは、LaTeXのデフォルトのfboxディレクティブを使用することです。

 \fbox{My text!}

または、より高度な機能(および見栄えの良いボックス)用のFancyBoxモジュール:http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox 。


1
pandoc-markdownノートがpandocテンプレートファイル内でどのように表示されるかを定義できるかどうか知っていますか?たとえば、〜/ .pandoc / templates / default.latexを編集しますか?
— tmaric 2014年

11

警告拡張機能を使用します。mkdocs、それが中に設定することができますmkdocs.ymlファイル:

markdown_extensions:
    - admonition

次に、次のようにmdファイルにメモを挿入します。

!!! note

     This is a note.

こちらの例をご覧ください。


8

Etienneのソリューションと同様に、単純なテーブルは適切にフォーマットされます。

| | |
|-|-|
|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|

もう1つの方法(より強調されます)は、コンテンツを本文のないテーブルのヘッダーにすることです。

|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|
|-|-|

最後に、水平線(主題の区切り)を含めて閉じたボックスを作成できます(ただし、線のスタイルは表のヘッダー行とは少し異なります)。

| | |
|-|-|
|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|

---

テキストの後の空の行に注意してください。


私はこのソリューションが大好きですが、pandocとxelatexを介してこれをpdfに変換すると、 " NOTE"列に50%、他の列に50%が割り当てられているようです。stackoverflow.com/questions/27219629に従って複数行のテーブルを使用できますが、他にもフォーマットの問題があります。
— sdbbs

7

これは簡単なラテックスベースの例です。

---
header-includes:
    - \usepackage[most]{tcolorbox}
    - \definecolor{light-yellow}{rgb}{1, 0.95, 0.7}
    - \newtcolorbox{myquote}{colback=light-yellow,grow to right by=-10mm,grow to left by=-10mm, boxrule=0pt,boxsep=0pt,breakable}
    - \newcommand{\todo}[1]{\begin{myquote} \textbf{TODO:} \emph{#1} \end{myquote}}
---

blah blah

\todo{something}

blah

その結果: ここに画像の説明を入力してください

残念ながら、これはラテックスであるため、TODOボックス内にマークダウンを含めることはできなくなり(通常、これは大きな問題ではありません)、PDF以外の形式(htmlなど)に変換する場合は機能しません。


5

次のメソッドは、GitHub、GitLab ...、および現在CommonMarkを使用しているStackoverflowで機能します。


> Blockquoteで作られたワンラインボックス

Blockquoteで作られたワンラインボックス


「バックティックで作られたワンラインボックス」

One-Line Box made with Backticks


`` `
トリプルバックティックで作られたボックス
` ``

Box made with Triple Backticks  


〜〜〜
トリプルチルダで作られたボックス
(この作品を作るためにチルダの間のスペースを取り除いてください)
〜〜〜

Box made with Triple Tildes


各行の先頭に4つのスペースで作成されたボックス:

    “Sometimes we must let go of our pride and do what is requested of us.”
    Padmé Amidala


...または水平線を使用しますか?

3つのダッシュ(---)は水平線を作ります:


注:「あなたの焦点があなたの現実を決定します。」–クワイ=ガン・ジン。


その他の構成については、優れたGitLab MarkdownGuideを強くお勧めします。
詳細度の低いGitHubの基本的なフォーマット構文を確認することもできます。Babelmark
を使用してMarkdownの実装を比較できます。

役立つヒント:

  • 改行を強制するには、行の終わりに2つのスペースを置きます。

  • 特殊文字をエスケープするには、\を使用します。


3

ダブルタブを使ってみましたか?箱を作るには:

Start on a fresh line
Hit tab twice, type up the content
Your content should appear in a box

これは、html出力のある通常のRmarkdownドキュメントで機能します。ダブルタブ部分は、丸みを帯びた長方形の薄い灰色のボックスに表示されます。


VS CodeとGitHubでも動作します!
— Nagev


0

別の解決策は、CSS隣接関係を使用し、h4(またはそれ以降)を使用することです。

#### note

This is the note content
h4 {
  display: none; /* hide */
}

h4 + p {
  /* style the note however you want */
}
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.