web-dev-qa-db-ja.com

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

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

markdownpandoc
41
TJB

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

---
**NOTE**

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

---

これは次のようなものです：

[〜＃〜] note [〜＃〜]

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

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

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

41
cartoonist

GitHubでは、通常、ブロック引用符を挿入します。

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

になる...

NOTE：メモの内容。

もちろん、常にプレーンHTMLがあります...

23
Vlad

私がまったく同じ問題を見つけた最も簡単な解決策は、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の場合）は、ラテックスのデフォルトfboxディレクティブを使用することです：

 \fbox{My text!}

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

12
Etienne Savard

admonition 拡張機能を使用します。 mkdocs の場合、mkdocs.ymlファイル：

markdown_extensions:
    - admonition

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

!!! note

     This is a note.

例を参照してください here 。

7
Boni García

簡単なラテックスベースの例を次に示します。

---
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

結果は： enter image description here

残念ながらこれはラテックスであるため、TODOボックス内にマークダウンを含めることはできなくなり（通常は大きな問題ではありません）、PDF （例：html）。

5
naught101

https://www.npmjs.com/package/markdown-it-container を使用することもできます

::: warning
*here be dragons*
:::

その後、次のようにレンダリングされます。

<div class="warning">
<em>here be dragons</em>
</div>
1
Alinex

ダブルタブを使用してみましたか？箱を作るには：

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

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

0
Cho Jay