Markdownの標準的な書き方について調べてみた

はじめに

この記事では、「Markdownの標準的な書き方」について書いています。

Markdownは文書を書く時にとてもお世話になっているのですが、使うツールによってはサポートされてない記法があったりするのがイヤで、「何が標準の記法で何が拡張の記法なんだ」となったのがこの記事を書いたきっかけです。

自分に向けた備忘録の意味もありますが、「どこでも同じように表示されるMarkdownの標準的な書き方が知りたい」な人の一助になれば嬉しいです。

MarkdownとはHTMLを、テキスト上で簡略化して表記できるという特徴を持つフォーマットのことです。

簡単で、覚えやすく、また手軽に文章構造を明示できるのが特徴です。

ただ、そもそものMarkdownに厳密な仕様がなかったため、それぞれが独自の解釈をし、方言（そのツール特有の書き方）が色々作られました。

その結果、ツール（処理系）によって処理結果が変わってしまうことが発生してしまいます。

例えば警告などを強調して表示する書き方ですが、QiitaやZennでは

:::note warn
警告
○○に注意してください。
:::

ですがGitHubでは

> **Warning**
> `Note`と`Warning`がとりあえず使えるらしい

だったり、そもそもそんな書き方はないものもあったりします。

Markdown は標準仕様を定めていないことを問題視した人たちが作った記法（仕様）

普段使っているMarkdownの記法はこの仕様に基づいて提供されているそうです。（※注：ちゃんと確認したわけではありません）

また、GFM (GitHub Flavored Markdown) という、GitHub上で利用できるMarkdownもCommonMarkを基に拡張したものらしいです。

なのでこのCommonMarkの書き方を守ってれば、どのツールでも大丈夫そうだと言えそうです。

以下のサイトに書いてあります

日本語版は、下記サイトにあります（ただ、英語最新版の訳はまだ対応してなさそうです）

「Markdownの標準的な書き方」について解説しました。

CommonMark Specに沿って書き、細かい所はツールの方言にしたがって書くと、文書作成も捗るかと思います。

（GitHub周辺でちゃんと表現できればそれで充分、ならGFMでもいいかもしれません）

さいごに、記事を書く上で参考にしたサイトのリンクを以下に掲載します。合わせて読んでいただくと良いかと思います。