Markdownの箇条書きでの「ぶら下げ」と、ぶら下げブロック内でコードサンプルを綺麗に書く

訳あってStyleCopのエラーメッセージを和訳してコーディング規約に仕立てるという楽しい作業をやっているのですが、あまりに苦行なのでマークダウンで綺麗に仕上げてみようと思いました。そもそも英語で読めねぇ、という人たちが単純和訳しただけの文章で実際の規約を理解できるか怪しかったので、サンプルコードも載せたいところ。規約は箇条書きで書くことにしたのですが、できれば英文の次の行に日本語、さらに日本語と同じ階層でサンプルも記載したい。そこでちょっと記法について調べてみました。結論から言うと

• 箇条書きの末尾にスペース2個を入れて改行したら、次の行は箇条書きのぶら下げブロックになる。
• サンプルコードも冒頭に2文字のスペースを入れれば、箇条書きのぶら下げと同じ階層にコードサンプルブロックごとインデントされる。

とのこと。

こんな感じですね。ちょっとわかりづらいですが。ぶら下げ自体は、箇条書きの行末にbr句を入れることでも実現できますが、半角スペース2個の方がスマートですね。ちなみにこの件はgithubのフォーラムで調べました。

github.com

考えながら書く人のためのScrivener入門 小説・論文・レポート、長文を書きたい人へ

はじめてのMarkdown 軽量マークアップ言語の記法と使い方 （I／O　books） [ 清水美樹 ]