MarkupとVimを布教する論

Markdown記法

　CommonMark 0.31.2に則って、 Markdown記法の内文芸作品を書く用途に有用と思えるものを紹介していきます。

　また、本文書独自の記法として

================

「Markdown記法」

|==============|

「表示される文章」

================

「説明」

　として記述します（前ページでフライングして使いましたが）。どうかバベルと同じ雷が筆者に落ちないことを祈ってください。

　また、半角スペースを顕に書く場合に ␣を用います。

　・見出し

================

# H1

## H2

### H3

|==============|

H1

H2

H3

================

　本来はこの#の数で見出しの深さが変わり、章や節などを管理することができるのですが、カクヨムでは大文字や太字などがサポートされていないため素の文字だけが表示されます。

　#の数は1から6までで、数が大きいほどより下位の階層になります。

　また、#と見出しの間には␣、タブ文字のいずれかが入らなくてはいけません。

　・改行

================

よし、この章を書いて……

あっ！？\

こんな物を書いて誰が喜ぶんだ␣␣

お前はいつもそうだ␣␣誰もお前を愛さない

|==============|

よし、この章を書いて…… あっ！？

こんな物を書いて誰が喜ぶんだ

お前はいつもそうだ 誰もお前を愛さない

================

　行の最後にバックスラッシュ（環境によっては￥マークで表示されているかもしれませんが、＼の半角です。ただし、￥マークでも問題ありません）を1つ、もしくは␣を2つ並べることで、次の行が空行でない場合に改行することができます。

　ただし、行の途中で␣を2つ並べても、半角スペースひとつ分の余白としてみなされます。

　また、空でない行2つが行末の処理を行わずに続いている場合はひと続きとしてみなされます。

　・改段落

================

聞こえるか？

はい、聞こえていますよ

。

エアロックを開けてくれ

。

<br>

それは……

できません

。

|==============|

聞こえるか？

はい、聞こえていますよ。

エアロックを開けてくれ。

それは…… できません。

================

　空行は改段落とみなされ、（設定にもよりますが）間に一行の空行が挿入されます。

　厳密に言えば<p>タグの切れ目とみなされ、 CSSに従って整形されるのですが、大抵のアプリでは（少なくともブラウザでは）空行が1つ挿入されるようです。

　また、空行がいくつあっても間に挿入される空行は1つです（タグの切れ目というだけなので当たり前ですが）。

　（意味付けという意味で望ましくありませんが）二行以上の空行を挿入したい場合は HTMLの改行タグ<br>を直接用いることができます。

　（HTMLユーザーへの補足：つまり、 xxx\[CR]vvv = <p>xxx<br>vvv</p>、 xxx[CR][CR]vvv = <p>xxx</p><p>vvv</p> ）

　・リンク

================

[ところでこいつはカクヨムのリンクさ](https://kakuyomu.jp/ )

[byref]: https://kakuyomu.jp/

[そしてこいつもカクヨムのリンク][byref]

|==============||

ところでこいつはカクヨムのリンクさ

そしてこいつもカクヨムのリンク

================

　カクヨム上ではただの文字列になっていると思いますが、 [text](path␣"title:opt") とすることでpathへのリンクを貼ることができます。

　text部分が実際にリンクが貼られる文字列の部分となり、 "title:opt"は無くても動きますが、書いておくと text上にマウスを持っていった場合にtitle:optに書いた文字列が表示されるようになります。この際、「"」を含めて書いてください。

　同様に、[label]:␣path␣"title:opt"として、 [text][label] と書くこともできます。

　HTMLを併用すればファイル内リンクも定義できますが、ここでは扱わないため、「アンカー」などの検索語でWEB検索してください（CommonMarkの変換規則を用いた裏技のため）。

　・特殊な文字

================

私のこと愛してる

？

もちろんさ

。

[](リンクにターゲット指定をしなければコメントの代わりになるんだ)

あなたの言葉で言ってよ

。

君のことを愛してるんだ

。

\[](コメントなら本心だって言える。そろそろ「逃げ出したく」なってきたよ)

……そう、あなたの気持ちはわかったわ

。

|==============|

私のこと愛してる？

もちろんさ。

あなたの言葉で言ってよ。

君のことを愛してるんだ。 [](コメントなら本心だって言える。そろそろ「逃げ出したく」なってきたよ)

……そう、あなたの気持ちはわかったわ。

================

　CommonMarkではいくつかの文字が命令のために確保されています。ここまでで見た「 #, <, >, [, ], (, ) 」の他にも箇条書きに用いられる-, *や、コンピュータ言語をそのまま表記するための~, `等があります。

　詳しいリストは元サイト[2]を見ていただくとして、これらの文字を文中に使いたい場合はバックスラッシュ「\」を記号の前に付けることで、そのまま表示することができます（このような操作を一般にエスケープと言います）。

　CommonMarkはHTMLに変換できない場合に文字列をそのまま表示するように設計されているため、上の例の様に頭をエスケープすることでその部分の命令を無効にできますが、安全性を求めるならば全てエスケープしておくことをおすすめします。