【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】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36
【Rails】devise-two-factorを使った2段階認証の実装方法【初学者】
# はじめに Railsアプリで2段階認証を実装するには、「rotp」というGemを使う方法の他に、「devise-two-factor」というGemを使う方法があります。「devise-two-factor」はその名の通り、IDとパスワードによ [...]
2021年12月12日 17:58
【Rails】rotpを使った2段階認証の実装方法【初学者】
# はじめに 昨今はIDとパスワードによる認証だけでなく、ワンタイムパスワードによる2段階認証を導入するWebアプリが増えてきました。Railsで作成したWebアプリでも、IDとパスワードによる認証に加えて2段階認証を導入するニーズが高まっていま [...]
2021年11月27日 13:02
【Rails】deviseを使った認証機能の実装【初学者】
# はじめに Railsアプリに認証機能を導入するには「devise」というGemを使う方法が最も簡単です。「devise」は認証に係る機能をほとんどコードを書くことなく実装できる反面、処理がブラックボックス化されており、全容が把握しづらいという [...]
2021年11月27日 13:01
【Rails】IDとパスワードによる認証機能の実装【初学者】
# はじめに 大抵のWebアプリでは、ユーザー登録/解除、ログイン/ログアウトといった認証機能を持っています。Railsには簡単に認証機能を導入できる「device」というGemが用意されています。「devise」は多くのRailsアプリで使われ [...]
2021年11月27日 13:00