【Rails】Markdownで記事を書く!「Redcarpet + Rouge」の導入・使用方法

2022年6月7日 22:10

はじめに

当ポートフォリオサイトの記事投稿画面では、長らく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を行います。

Gemfile

gem 'redcarpet'
gem 'rouge'

Redcarpetの設定

まず、app/helpers/配下にmarkdown_helper.rbを作成し、以下のように記述します。

app/helpers/markdown_helper.rb

require 'rouge/plugins/redcarpet'

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

module MarkdownHelper
  def markdown(text)
    options = {
      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,
    }

    renderer = CustomRenderHTML.new(options)
    markdown = Redcarpet::Markdown.new(renderer, extensions)
    markdown.render(text).html_safe
  end

  def toc(text)
    renderer = Redcarpet::Render::HTML_TOC.new(nesting_level: 3)
    markdown = Redcarpet::Markdown.new(renderer)
    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 見出しは#の後にスペースを空ける

Rougeによるシンタックスハイライトを有効にするため、Rougeのプラグインをincludeしたカスタムクラスのインスタンスとしてレンダラーを作成します。

tocメソッド

TOCとはTable Of Contentsのことで、目次を意味します。markdownメソッド内でwith_toc_dataを有効にしている必要があります。

toc_optionのパラメーターとその意味は以下の通り。

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

Markdownドキュメントの表示

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

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

Markdownからプレーンテキストに変換

Markdownで書いた文章を、ある場所ではプレーンテキスト(Markdownキーワードを含まない)で表示したい場合があります。当ブログの場合、記事一覧ページの各記事の本文がそれにあたります。Redcarpetには、Markdownで書いた文章をプレーンテキストに変換するRedcarpet::Render::StripDownというAPIが用意されています。

Markdownをプレーンテキストに変換するヘルパーメソッドを作成します。

app/helpers/markdown_helper.rb

require 'redcarpet'
require 'redcarpet/render_strip'

module MarkdownHelper
  def plaintext(text)
    markdown = Redcarpet::Markdown.new(Redcarpet::Render::StripDown)
    markdown.render(text)
  end
end

あとはプレーンテキストを表示させたい場所でplaintextメソッドを呼び出すだけです。

<%= plaintext(@article.content) %>

Rougeの設定

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

app/assets/stylesheets/_rouge.scss.erb

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

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

assets/stylesheetsapplication.scss

@import 'rouge';

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

カラーテーマの変更

Rougeにはシンタックスハイライトのカラーテーマがいくつか用意されています。使用できるカラーテーマの一覧と使用方法について詳しくは以下の記事を参照してください。

まとめ

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

関連記事

【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12
【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】
# はじめに RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。 入力フォームの内容を書 [...]
2022年1月27日 21:22
【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