【Rails】Markdownで記事を書く!『redcarpet+rouge』の導入・使い方を解説【シンタックスハイライト対応】

2021年4月5日 21:54

はじめに

当ポートフォリオサイトの記事投稿画面では、長らくRails6の新機能・Action Textを使っていました(Action Textについては下記の記事をご覧ください)。

導入当初は便利な機能だなぁと思って使っていたんですが、使い続けているうちにいくつか不満点が出てきました。
最大の不満点は、コードのシンタックスハイライトができないことです。
シンタックスハイライトとは、コード内のキーワードに基づいて色付けを行うことです。色付けを行うことにより、コードの可読性が格段に高まります。

今までの記事ではこんな感じで表示していました。

  def sending
    @contact = Contact.new(contact_params)
    if @contact.valid?
      ContactMailer.send_mail(@contact).deliver_now
      redirect_to contact_done_path
    else
      render 'statics/index'
    end
  end

これにシンタックスハイライトを適用させるとこんな感じになります。

  def sending
    @contact = Contact.new(contact_params)
    if @contact.valid?
      ContactMailer.send_mail(@contact).deliver_now
      redirect_to contact_done_path
    else
      render 'statics/index'
    end
  end

どうでしょうか。明らかにシンタックスハイライトありのほうが読みやすいですね。

シンタックスハイライトを適用させるには、Markdownという決め事に則って文章を書く必要があります。
今回はMarkdownで書いた文章をHTMLに変換してくれるredcarpetと、コードのシンタックスハイライトを行ってくれるrougeという2つのGemの導入・使い方を解説します。

redcarpet・rougeの導入

Gemfileに以下を追記してbundle installを行います。

...
gem 'redcarpet'
gem 'rouge'

redcarpetの設定

まず、app/helpers/配下にmarkdown_helper.rbを作り、以下のように設定します。

require 'rouge/plugins/redcarpet'

class HTML < Redcarpet::Render::HTML
  include Rouge::Plugins::Redcarpet
end

module MarkdownHelper
  def markdown(text)
    options = {
      no_images:     true,
      no_styles:     true,
      with_toc_data: true,
      hard_wrap:     true
    }

    extensions = {
      no_intra_emphasis:   true,
      tables:              true,
      fenced_code_blocks:  true,
      autolink:            true,
      lax_spacing:         true,
      space_after_headers: true
    }

    unless @markdown
      # Redcarpet::Render::HTML => HTML に変更
      renderer = HTML.new(options)
      @markdown = Redcarpet::Markdown.new(renderer, extensions)
    end

    @markdown.render(text).html_safe
  end

  def toc(text)
    markdown = Redcarpet::Markdown.new(
      Redcarpet::Render::HTML_TOC.new(nesting_level: 3)
    )
    markdown.render(text).html_safe
  end
end

markdownメソッドを見ていきます。

options
以下のパラメーターを有効にしています。使用できるパラメーター一覧はこちら

パラメーター 意味
no_images <img>タグを生成しない
no_styles <style>タグを生成しない
with_toc_data 見出しにアンカーを付ける
hard_wrap 改行を<br>タグに変換

extensions
以下のパラメーターを有効にしています。使用できるパラメーター一覧はこちら

パラメーター 意味
no_intra_emphasis 単語内の強調を解析しない
tables テーブルを有効化
fenced_code_blocks 複数行のコードを有効化
autolink http https ftpで始まる文字列を自動リンク
lax_spacing 複数行のコードの前後に空行が不要
space_after_headers 見出しは#の後にスペースを空ける

optionsextensionsRedcarped::Markdown.new()に渡して、MarkdownドキュメントをHTMLに変換しています。

続いてtocメソッドを見ていきます。markdownoptionswith_toc_dataを有効にしている必要があります。
ちなみにTOCとはTable Of Contentsのことで、要するに目次のことです。

toc_option
使用できるパラメーターはnesting_levelのみ。

パラメーター 意味
nesting_level 見出しのネストレベル(整数)

rougeの設定

app/assets/stylesheets/配下に_rouge.scss.erbを作り、rougeのカラーテーマを読み込みます。

<%= Rouge::Themes::Base16.render(:scope => '.highlight') %>

最後に、assets/stylesheetsapplication.scssに以下を追記してrougeをインポートします。

@import 'rouge';

以上でMarkdownを表示する準備ができました。

Markdownドキュメントの表示

Markdownを表示したいビューで以下のようにヘルパーを呼び出せば、Markdownドキュメントが表示されます。

<%= toc(@article.content) %>
<%= markdown(@article.content) %>

rougeのカラーテーマを変更

rougeにはシンタックスハイライトのカラーテーマがいくつか用意されています。カラーテーマはRouge Theme Preview Pageからプレビューを確認することができます。
シンタックスハイライトのカラーテーマを変更するには_rouge.scss.erbを以下のように変更します。

変更前

<%= Rouge::Themes::Base16.render(:scope => '.highlight') %>

変更後

<%= Rouge::Themes::Monokai.render(:scope => '.highlight') %>

まとめ

Markdownで記事を書くには、まずMarkdown記法というものを覚えなければなりません。
しかし、MarkdownはGitHubやStack Overflowなどでも標準的に使われている記法です。エンジニアの方なら一度はこれらのサイトを利用したことがあるはずです。
Markdownを知らなかったという人はこの機会にMarkdownを覚え、Railsアプリにも導入してはいかがでしょうか。

関連記事

【Rails】ダウンロードしたフリーフォントをWebpackerを使って導入する方法
# はじめに Webサイトのデザインを彩るひとつの要素にフォントの種類があります。Google Fontsの登場により、様々なフォントが手軽に導入できるようになりました。しかし、世の中にはGoogle Fontsが提供するフォント以外にもたくさん [...]
2021年10月16日 13:26
【Rails】mimemagicに依存しているRailsアプリでbundle installコマンドが失敗する事象の対処法
# はじめに Railsアプリで`bundle install`コマンドを実行しようとしたところ、以下のエラーメッセージが出力されコマンドに失敗しました。 ``` Your bundle is locked to mimemagic (0 [...]
2021年10月14日 14:44
【Rails】macOSのアップデート後にrailsコマンドが失敗する事象の対処法
# はじめに 久しぶりにRailsアプリに手を入れようと思い、`rails server`コマンドを実行してRailsサーバーを立ち上げようとしたところ、エラーが出て起動に失敗してしまいました。 前回までの間にしたことの中で思い当たることと [...]
2021年10月14日 12:11
【Rails】Railsアプリのデバッグ《マルチデバイス篇》
# はじめに 近年のWebアプリはレスポンシブ対応が当たり前になっています。最低でもPCとスマートフォンに対応したデザイン、ときにはその中間のタブレットに対応したデザインなんかも作成する必要があります。 Webアプリの開発はPCを使って行う [...]
2021年5月23日 13:02
【Rails】Railsアプリのデバッグ《Better Errors篇》
# はじめに Railsアプリの開発中になんらかのエラーが発生すると、デフォルトでは以下のような画面が表示されます(画像をクリックすると拡大します)。 <a class="gallery" data-group="gallery" href [...]
2021年5月22日 19:42