【GatsbyJS】ブログにZennのようなメッセージを記事に埋め込む

2021-06-23

はじめに

おはようございます!こんにちは!こんばんは!
のふのふ(@rpf_nob)と申します!!都内のスタートアップでフロントエンドエンジニアとして働いています。

今回は GatsbyJS ブログに[gatsby-remark-custom-blocks]というパッケージを利用して Zenn のようなメッセージを記事に埋め込めるようにしたので実装方法を解説します!!

  • 前提
  • パッケージのインストール
  • gatsby-config.js の編集
  • 記事を作成するマークダウンファイルに埋め込む
  • スタイリング
  • まとめ

前提

このブログは GatsbyJS のgatsby-starter-blogのテンプレートから作成しています。


ソースコードはこちら(参考になったという方は ⭐️ をポチッと押していただけると嬉しいです〜 🙇‍♂️)

パッケージのインストール

今回はgatsby-remark-custom-blocksを使って実装します。 基本的には公式ページのままやれば簡単にできます。

$npm install --save gatsby-remark-custom-blocks

gatsby-config.js の編集

インストールしたgatsby-remark-custom-blocksを plugins の gatsby-transformer-remark の options の plugins に設定していきます。

今回はinfo と warn と questionというブロックを作りました。classes と別に title というオプションもありますが、今回はタイトルはつけないので classes だけにしています。

gatsby-config.js
plugins: [
  {
    resolve: `gatsby-transformer-remark`,
    options: {
      plugins: [
        {
          resolve: "gatsby-remark-custom-blocks",
          options: {
            blocks: {
              info: {
                classes: "info",
              },
              warn: {
                classes: "warn",
              },
              question: {
                classes: "question",
              },
            },
          },
        },
      ],
    },
  },
];

記事を作成するマークダウンファイルに埋め込む

埋め込み方は以下のとおりです。マークダウンファイルに以下のように記載します。

[[info]]
| ここに情報文を書く

[[warn]]
| ここに警告文を書く

[[question]]
| ここに質問文を書く

すると次のような HTML が記事内に埋め込まれます。

<div class="custom-block info">
  <div class="custom-block-body">
    <p>ここに情報文を書く</p>
  </div>
</div>

<div class="custom-block warn">
  <div class="custom-block-body">
    <p>ここに警告文を書く</p>
  </div>
</div>

<div class="custom-block question">
  <div class="custom-block-body">
    <p>ここに質問文を書く</p>
  </div>
</div>

ちなみに title オプションを設定して、以下のようにタイトルを書いてあげれば次のような HTML にもなります。

[[info] タイトル]
| ここに情報文を書く
<div class="custom-block info">
  <div class="custom-block-heading">タイトル</div>
  <div class="custom-block-body">
    <p>ここに情報文を書く</p>
  </div>
</div>

スタイリング

あとはスタイリングをするだけなので CSS を書いていきます。

.info {
  border-radius: 5px;
  margin: 0 1rem;
  margin-bottom: 2rem;
}
.info > .custom-block-body {
  position: relative;
  margin: 1.5rem 0;
  padding: 5px 15px 5px 40px;
  border-radius: 6px;
  background: #fff6e4;
  color: #222;
  font-size: 0.875em;
  line-height: 1.6;
}
.info > .custom-block-body::before {
  position: absolute;
  left: 15px;
  top: 50%;
  transform: translateY(-50%);
  content: "!";
  display: block;
  width: 20px;
  height: 20px;
  line-height: 20px;
  font-size: 13px;
  text-align: center;
  color: #fff;
  background: #ffb84c;
  font-weight: 700;
  border-radius: 50%;
}

warn と question は色とマークの変更だけなので割愛します。

結果以下のように Zenn のメッセージのようなブロックが作成できました。

ここに情報文を書く

ここに警告文を書く

ここに質問文を書く

まとめ

今回は GatsbyJS ブログに[gatsby-remark-custom-blocks]というパッケージを利用して Zenn のようなメッセージを記事に埋め込めるようにしたので実装方法を解説しました!!

ブログによくある吹き出しみたいなブロックもこれで作成できると思うので、追加したい方は実装してみてください。

他にも GatsbyJS のブログカスタマイズをいろいろやっているので、以下もあわせてご覧いただければと思います。



最後まで見ていただきありがとうございます!! この記事が良かったと思ったら SHARE していただけると泣いて喜びます 🤣


©2020-2021.のふのふ🀄All Rights Reserved.