概要
マークダウンとは、乱暴に言うと次のルールでテキストを書くこと(記法)。
- 章タイトル／見出しは「
#」で始める - 箇条書きは「
-」もしくは「*」で始める - 引用は「
>」で行う
以上！
本記事の目的
「マークダウンってなんですか？」って聞かれることがそこそこの機会あり、その時に如何に簡単に説明するか？を言語化したかった。
文章構造を表現するためのフォーマットだとか、マークダウンはHTMLへの変換を目的としたものだとか、籠めたい想いや内容の不足はいろいろあるが、「細けぇことはイインダヨ」という方針で、表現してみたくなった。
余白
Markdown（マークダウン）は、文章の書き方です。
http://www.markdown.jp/what-is-markdown/
Markdown is a text-to-HTML conversion tool for web writers.
もうすこし詳しく
数行で説明しようとするなら、上記の述べ方、が私が聞く立場ならばしっくりくるかな（異論は認める）。
んで、「記法はそれだけ？何が嬉しいの？」って興味をもって聞き返されたら、次のように答えるかな。
どういう記法か？
次のルール（フォーマット）に則ってテキストを書くことを「マークダウン（記法）で書く」と呼ぶ。
- 章タイトル／見出しは「
#」で始める- 半角記号の後ろに半角スペースを1つ入れる
- 節タイトルや小見出し等の階層構造を「
##」、「###」で表現する
- 箇条書きは「
-」もしくは「*」で始める- 半角記号の後ろに半角スペースを1つ入れる
- 実は「
+」も使える。
- 入れ子構造にするときは、半角スペース4つインデントする。
- 例：「
-」、「*」※表現の都合で全角スペース利用。 - 番号を振りたい時は「
1.」とする。- 全部「
1.」「1.」でもよいし、「2.」「3.」とカウントアップしても良い。
- 全部「
- 例：「
- 引用は「
>」で行う- 半角記号の後ろに半角スペースを1つ入れる
-
強調は「
次の**ABC**の部分を」のようにアスタリスク２つで囲う。
より詳しい記法は、「Markdown記法 チートシート」などで検索のこと。
何が嬉しいの？
まず、次のことが嬉しい。
- テキストを書いた人と読んだ人との間で、見出しや箇条書きの部分での認識齟齬が生まれない。
- 箇条書きの記号として何が良いか？を悩む手間が省ける。
- 互いに「この記号は、、、何を意図したのだろう？」などと、文章の外側の部分で迷わずに済む。
そして、環境がそろえば容易に「見出し、箇条書き、引用などをいわゆるHtml相当で装飾した状態」で見る／見せることが出来る、ことが嬉しい。
なお、以下ではテキストファイルを「*.md」の拡張子で保存することを前提とする。
-
Visual Studio Code でファイル（左）を開くと、装飾状態をプレビューでリアルタイム表示できる（右）。
- VSCodeにプラグイン「
vscode-pandoc」をインストールすることで、プレビュー表示に沿ってHTMLファイル、Wordファイルへ簡単に変換できる。 - GitHubに入れた時には、ブラウザ上でプレビュー表示のように表示しててくれる。
- いわゆる「README.md」などのファイルがコレ。
余白
VSCodeでMarkdownを Word や PDF に変換してみる
まとめ
Markdownとは、テキストで見出しや箇条書きを悩まずに表現して齟齬なく伝えることが出来る記法。
ついでに、実際に装飾したWordやHtmlへ変換できるのが嬉しい記法。
改めて以上ー。