MiddlemanでMarkdownの改行がbrタグに変換されるようにする方法

middleman

MiddlemanのMarkdownはデフォルトのままだと普通に改行してもbrタグは入らない

GitHub上でissueやpull requestを書く時に使われているMarkdownだと改行するとhtml上でもちゃんと改行されますよね。これは改行がbrタグに変換されるからです。

Middlemanだとデフォルトのままだと普通に改行してもbrタグは入りません。同じ行につながっている文字列に見えます。

MiddlemanのデフォルトのMarkdownパーサーはkramdownというライブラリなのですが、改行の場所でbrタグを生成するためには、行末にスペースを二つ入れる必要があります

行末のスペース二つというのは手間だし、コードの見た目でわかりずらくミスを誘発しそうですよね。

GFM(Github Flavored Markdown)を使うとGitHubと同じ挙動になる

kramdownにGFMというオプションを渡してあげると、Githubと同じ改行の挙動となります。
これをMiddlemanでやるには以下をconfig.rbに追加します。

1
set :markdown, input: "GFM"

これで、Markdown上の改行がbrタグに変換されるようになります。

※Middlemanのバージョン: 3.4.0

羊毛や小麦