Markdown

“文書を記述するための軽量マークアップ言語のひとつである。” ( Markdown - Wikipedia)

最終的な変換後の言語や中間の言語として HTML を想定しているが、Markdown では HTML (マークアップ言語) のようにタグで囲むことはしないため、編集しやすい。そもそも、記法自体が、目視で状況を把握できるので編集しやすい。

また、Markdown の記法に存在しないスタイルがある場合、HTML 形式で記述すれば対応可能であったりする。

Markdown には複数の種類が存在する。

ここでは、ドキュメントコンバータ Pandoc で扱える Markdown の Tips を紹介する。

基本的には、行頭に # や ## を付ける。

# の数が多いほど、レベルが上になる。

基本的に、文書のタイトルはレベル 1 の # で表示し、その他の一般的な見出しはレベル 2 以上の見出しを使う。

この他にも、見出し記法はあるが、割愛。

太字: 太字にしたい文字を ** で囲む。

斜体: 斜体にしたい文字を * で囲む。

下線: 記法は存在しないため、HTML で記述する。

上付き: 上付きにしたい文字を ^ で囲む。

下付き: 下付きにしたい文字を ~ で囲む。

---- のみの行。

箇条書きと番号付きリストは混合できる。

LaTeX 形式で記述可能であり、数式はインラインでは $ で囲み、複数行の場合は、$$ で囲む。

数式に番号を付ける場合は、タグ \tag{X} を利用し、数式番号は X に直接入力する。

教科書なんかで、ページの下に水平線と共に文章中の意味を説明するアレ。

文書内では、[^X] (X は番号) を説明したい単語の後に付ける。

文章の末端に、[^X]: DESC (DESC は説明文) の行を追加する。