TIESのブログ

GithubのMarkdownには方言がある?

on 2015年4月8日

先月ブログに書いたCHiLOBook-Producerのマニュアルが完成に近づいてきました。
以前書いていたときと比べて、製作の流れがだいぶ分かりやすくなってきたのではないかと思います。

さて、上記リンクの記事で、GithubのWikiに使えるとご紹介した軽量マークアップ記法"Markdown"ですが、
実はGithubでは独自で使える記法(いわば方言)があります。

たとえば、マニュアル内に複数行のHTMLコードを記載したい場合、
Markdownのルールではコード各行の先頭に4つ以上のスペースを入れることになっていますが、
Githubではバッククオート(Shift+@)3つで前後を囲む記法もOKになっています。

```
<div class="l_contents">
 <img src="../images/[画像名]" />
</div>
```

結果は以下のようになります。

code

さらに先頭のバッククオートの後に"html"とつけると...

```html
<div class="l_contents">
 <img src="../images/[画像名]" />
</div>
```

このようにタグをハイライトして表示してくれます。

hylights

色がつくと、断然見やすいですね。

その他の記法についてはGithub HelpサイトのGitHub Flavored Markdownで紹介されています。
打ち消し線は、よく使う機会がありそうですね。

参考: