Octopress で GitHub Flavored Markdown (GFM) を使う

2013-05-06

何かを書く際には Markdown がとても良いですが、できれば GitHub Flavored Markdown (GFM) で書きたいものです。
おそらく多くの人にとって、単に改行しただけでは <br> タグが挿入されないことは不快になると思います。

Otcopress で GFM を使うシンプルな方法は、パーサとしてデフォルトの RDiscount ではなく、Redcarpet を使うことのようです。

方法

1. Gemfile に gem 'redcarpet', '~> 2.1.1' を追加
   (後述する plugin で Albino も必要になるので、なければ gem 'albino', '~> 1.3.3' も追加)
2. bundle install
3. plugins ディレクトリに redcarpet2_markdown.rb ( source code ) を追加
4. _config.yml の markdown: rdiscount を下記のように書き換え

markdown: redcarpet2
redcarpet:
  extensions: ["hard_wrap"]

以上で基本的な GFM の記法が使えるようになりました。
extensions を追加することで色々と設定できるようです。

参考

• Using Octopress with Github Flavored Markdown (RedCarpet) - Aspiring Entrepreneur