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

はじめに

当ポートフォリオサイトの記事投稿画面では、長らく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】RSpecを使った自動テスト《システムスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 17:07
【Rails】RSpecを使った自動テスト《リクエストスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 16:06
【Rails】RSpecを使った自動テスト《コントローラースペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 15:39
【Rails】RSpecを使った自動テスト《基本編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月10日 17:49
【Rails】デザインパターン「Concern」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月10日 13:32
【Rails】デザインパターン「Form Object」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月6日 22:50
【Rails】デザインパターン「Service Object」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月6日 19:59
【Rails】Dockerを使用してRuby on Railsの開発環境を構築
# はじめに Ruby on Railsは強力なWebアプリケーションフレームワークですが、開発環境の構築には時間がかかることがあります。特に、チーム全体で一貫した環境を維持することは困難な場合があります。 Dockerを使用することで、R [...]
2024年7月5日 18:49