マークダウンでドキュメントを書いています。私は素晴らしいpandocを使用して、マークダウンソースからdocxファイルとtexファイルを作成しています。プログラミングの本と同じように、読者へのヒントやメモ用のテキストボックスが欲しいのですが。マークダウンでこれを行う方法がわかりません。手伝ってくれますか?
マークダウンでドキュメントを書いています。私は素晴らしいpandocを使用して、マークダウンソースからdocxファイルとtexファイルを作成しています。プログラミングの本と同じように、読者へのヒントやメモ用のテキストボックスが欲しいのですが。マークダウンでこれを行う方法がわかりません。手伝ってくれますか?
回答:
マークダウンテキストにアラートボックス(メモや警告など)を配置するために私が通常行うことは(pandocを使用している場合だけでなく、そのマークダウンがサポートされているすべての場所でも)、コンテンツを2本の水平線で囲んでいます。
---
**NOTE**
It works with almost all markdown flavours (the below blank line matters).
---
これは次のようになります。
注意
すべてのマークダウンフレーバーで機能します(以下の空白行が重要です)。
良い点は、サポートされているマークダウンフレーバーや、インストールまたは有効化されている拡張機能について心配する必要がないことです。
編集:@ filups21がコメントで述べたように、水平線は***
RMarkdownで表されているようです。したがって、前述のソリューションは、最初に主張されたように、すべてのマークダウンフレーバーで機能するわけではありません。
***
前に空白行があります。または、>
(空白行が前に付いている)で行を開始して、メモをブロッククォートに入れることもできます。
GitHubでは、通常、ブロッククォートを挿入します。
> **_NOTE:_** The note content.
になる...
注: メモの内容。
もちろん、プレーンHTMLは常に存在します...
> ℹ️ This is an information
またはなどのメモの接頭辞を付けることも楽しんでいます> ⚠️ This is a warning
。
まったく同じ問題に対して私が見つけた最も簡単な解決策は、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 。
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.|
---
テキストの後の空の行に注意してください。
NOTE
"列に50%、他の列に50%が割り当てられているようです。stackoverflow.com/questions/27219629に従って複数行のテーブルを使用できますが、他にもフォーマットの問題があります。
これは簡単なラテックスベースの例です。
---
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など)に変換する場合は機能しません。
次のメソッドは、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つのスペースを置きます。
特殊文字をエスケープするには、\を使用します。
https://www.npmjs.com/package/markdown-it-containerを使用することもできます
::: warning
*here be dragons*
:::
次に、次のようにレンダリングされます。
<div class="warning">
<em>here be dragons</em>
</div>