feed

2013年11月13日, 編集履歴

JekyllのMarkdown設定（2013年11月18日追記）

　Jekyllを使ってウェブサイトとブログの再構築をした。その際に用いたMarkdown用の設定メモ。
　現時点での_config.ymlファイルのMarkdown関係の設定は以下。

markdown: redcarpet
redcarpet:
  extensions: ["autolink", "hard_wrap"]

　生の設定ファイルはgenjiapp.github.io/_config.yml at master。

Markdownレンダラの変更

　JekyllのディフォルトのMarkdownレンダラはMaruku。これをRedcarpetに変更した。なぜ変更したか。きっかけは、MarukuではTwitterの埋め込みコード（以下のようなもの）

<blockquote class="twitter-tweet"><p>ヘウレーカ！　JekyllでコンテンツをHTMLで書いて良いことと、レイアウト側だけではなくコンテンツ側でも include が使えることに気がついて、蒙が啓けた気がする</p>&mdash; Genji (@genji_tw) <a href="https://twitter.com/genji_tw/statuses/398471861828206592">November 7, 2013</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>

がうまく変換できずエラーを吐くことに気がついたから。_config.ymlでmarkdown: redcarpetと指定することで、MarkdownレンダラをMarukuからRedcarpetに変更できる。Redcarpetなら上記の埋め込みコードを正常に処理できる。

Redcarpetの拡張設定

　指定した拡張はautolink、hard_wrapの2つ。

　autolinkは http://genjiapp.com/ のような文字列を自動でリンクに変換してくれる。

　次にhard_wrap。Markdownは標準では空行を挿入しないと改段落にならない（ブラウザでの表示で行分けされない）。つまり、

あめんぼあかいな
あいうえお

ほげほげ

とMarkdownを書くと、変換後のHTMLは

<p>あめんぼあかいなあいうえお</p>
<p>ほげほげ</p>

のようになる。Markdown上での単なる改行は改段落とはならずひとつの<p>タグに纏められ（「あめんぼあかいなあいうえお」が一行で表示される）、空行を挟んで新しい<p>タグが始まる。これは他の軽量マークアップ言語でもよくある仕様である。個人的な趣味でこの仕様があまり好きではない。
　hard_wrapを有効にすると上記のMarkdownは

<p>あめんぼあかいな<br/>あいうえお</p>
<p>ほげほげ</p>

のように変換される。Markdown上での改行が変換後に改段落されないのは同様であるが、改行部分に<br/>タグが挿入されるようになる（ブラウザでの表示において行分けされる）。
　HTMLの<p>タグひとつが日本語の意味段落に相当し、形式段落を<br/>で作るというイメージである。

追記（2013年11月18日）

　当初、Redcarpetの拡張設定はもうひとつ、no_intra_emphasisを指定していた。そして記事中では以下のようなことを書いた。

　Markdownは標準では複数のアンダーバー_間の文字列をHTML変換時に強調タグ<em>でくくる。これの何が問題かというと、プログラムの変数名等でありがちなhoge_foo_barのような文字列が意図せず強調されてしまう。no_intra_emphasisはその動作を抑制する。

　Markdownの強調構文にはアンダーバーを使う方法ともうひとつ、アスタリスク*を使う方法がある。ここで私が誤解していたのが、no_intra_emphasisはアンダーバーを使う強調構文のみが対象であると思い込んでいたことである。しかしno_intra_emphasisはアスタリスクを使う構文でも同様に作用する。

　これの何が問題かというと、分かち書きをしない日本語文中では、余分な空白を入れないと強調構文が使えなくなるということである。つまり、

ほげほげ*強調*ふーばー

と書いても、

<p>ほげほげ*強調*ふーばー</p>

と出力される。強調構文にするには、余分な空白を挿入して

ほげほげ *強調* ふーばー

としなければならなくなる。そうすると出力にも当然余分な空白が入り込む。それはイヤなのでno_intra_emphasisは外すことにした。
　プログラムの変数名等でアンダーバーが意図しない強調になってしまうという問題は、インラインコード／コードブロック構文中なら関係ないと気づいた。コード片を書くときは元々インラインコード／コードブロック構文を使っていたので、そもそもno_intra_emphasisは必要ないという結論に至った。