ニッチなCMSとAWS徒然日記

WordPressからmicroCMSへの移行〜フロントエンド開発編

microCMSはヘッドレスCMSとなります。APIを作成してデータを管理するツールとなっていて、フロント側(Webサイトやスマホアプリなど)は別に用意する必要があります。

今回は配布されているテンプレートをもとに、WordPressのブログで実装していた機能や要素について追加で開発した内容を紹介します。

開発環境の準備

Next.jsなどを利用してゼロからテンプレートを開発することも可能ですが、今回は公式から配布されているテンプレート「シンプルなブログ」を利用しました。

https://templates.microcms.io/

シンプルなブログ
https://templates.microcms.io/templates/detail/a530e59f-d66d-4b85-9ef5-4cf4288adb09

https://github.com/microcmsio/nextjs-simple-blog-template

テンプレートのReadmeに各種パッケージのインストール、環境変数、ビルドやローカルサーバが起動するコマンドなどが記載されているのでそちらを読みながら準備をしましょう。

シンプルなブログの構成であれば、上記テンプレートに基本的な要素は出力されています。この記事では追加で開発した内容を紹介します。

本文内画像のレスポンシブ、WebP対応

WordPressにアップロードされた画像はダッシュボードのメディアの設定や使用中のテーマに記載されたサイズでトリミングやリサイズの加工が行われます。

メディアライブラリに登録された画像は本文内に画像を挿入するとレスポンシブイメージで表示されるようsrcset、sizes属性が追加されたimgタグが挿入されます。
またメディアライブラリ内の画像をimgタグ直接ではなくWordPressの関数を使用して出力しても同様の処理がされます。

参考

wp_get_attachment_image
https://developer.wordpress.org/reference/functions/wp_get_attachment_image/

WordPressでのメディアのWebPへの変換はプラグインもしくは外部サービスなどを利用します。

プラグインタグ: webp
https://ja.wordpress.org/plugins/tags/webp/

Shifter Media CDN と WebP のサポート
https://ja.getshifter.io/shifter-support-documents/development/shifter-media-cdn-and-webp-support/

microCMSの場合、imgixを利用しているためパラメーターを指定すればレスポンシブイメージ、WebPで表示することができます。

フロントエンド側でロゴやアイキャッチ画像を表示する箇所で都度パラメーターを指定すれば良いのですが、本文内の画像はimgタグで保存されているため、出力時に本文のHTMLをパースして加工する必要があります。

具体的なコード例や画像APIの仕様や実装に関しては下記の記事をご参照ください。

参考

このブログで実装したコードは下記の記事を参考にしてください。

https://qiita.com/gatespace/items/de7221871682e930233d

AddToAnyを利用したシェアボタンの追加

https://www.addtoany.com/

このブログでは各記事にシェア用のボタンを追加してます。
各SNSで提供されているシェアボタン用のコードをそのまま挿入しても動作しますが、SNSサービスのAPIに変更があると、都度フロント側のコードも書き換える必要が出てきます。

個人で全てのSNSサービスのAPIを追い続けるのは大変ですので、各種SNSのシェアボタンをまとめて設置できる AddToAny を利用しました。

設置は通常のサイトと同じように AddToAny サイトで作成したコードをフロント側に追加するだけです。
シェアボタンボタン押下時に、サイト名や任意のテキストを追加したい場合は、AddToAnyのドキュメントを参考に、テキストもしくはmicroCMSから取得した情報を加工するなどしてコードに追加します。

https://www.addtoany.com/buttons/customize/

このブログで実装したコードは下記の記事を参考にしてください。

https://qiita.com/gatespace/items/3defc2cd7c2bcd098e9d

SEO関係

OGPは今回利用したテンプレートにコードが含まれています。

WordPressのプラグインのようにノーコードで投稿ごとに細かい設定をしたり、サイト全体の設定を管理画面などから共通で行いたい場合は、microCMS側にフィールドを追加し、フロントエンド側で出力できるよう開発しておく必要があります。

構造化データ

OGタグの中身と同じように、投稿ごとに細かい設定をしたりサイト全体の設定を共通で行いたい場合は、microCMS側にフィールドを追加し、フロントエンド側で出力できるよう開発しておく必要があります。
さらに今回利用したテンプレートには構造化データのコードは含まれていないので出力のための開発が必要となります。

このブログではOGPと構造化データで共通する内容を利用できるようにしています。実装したコードは下記の記事を参考にしてください。

https://qiita.com/gatespace/items/9211c739f7ecdbbc2700

robots.txt

robots.txtに除外ディレクトリを追加したり、xmlサイトマップへのリンクを追加し、適宜アップロードしましょう。

Next.js のドキュメントにサンプルがありますので、参考に実装しましょう。

https://nextjs.org/docs/app/api-reference/file-conventions/metadata/robots

import { MetadataRoute } from 'next'
import { BASE_URL } from '@/constants';

export default function robots(): MetadataRoute.Robots {

  return {
    rules: {
      userAgent: '*',
      allow: '/',
      disallow: [
        '/preview',      // microCMSのプレビュー確認用ページ
        '/api/',         // APIルート
      ],
    },
    sitemap: `${BASE_URL}/sitemap.xml`,
  }
}

XMLサイトマップ

フロントエンド側で作成しておく必要があります。
記事を更新したタイミングでサイトマップにも追記が必要になることと、件数が増えた場合は自動で分割をしてサイトマップ用のインデックスを作成することになるため、フロント側で開発し実装するようになります。

https://developers.google.com/search/docs/crawling-indexing/sitemaps/build-sitemap?hl=ja

Next.js のドキュメントにサンプルがありますので、参考に実装しましょう。

https://nextjs.org/docs/app/api-reference/file-conventions/metadata/sitemap#sitemap-files-xml

import { MetadataRoute } from 'next'
import { getList } from '@/libs/microcms';
import { BASE_URL } from '@/constants';

export default async function sitemap(): Promise<MetadataRoute.Sitemap> {

  // 固定ページの定義
  const staticRoutes = [
    { url: BASE_URL, lastModified: new Date() },
  ]

  const blogRoutes: MetadataRoute.Sitemap = []

  const LIMIT = 100 // microCMSの1回あたりの最大取得件数
  let offset = 0
  let totalCount = 0

  try {
    // 全件取得のためのループ処理
    while (true) {
      const data = await getList({
        fields: ['id', 'updatedAt'],
        limit: LIMIT,
        offset,
      })

      // 取得した記事情報(url, 更新日時)をサイトマップの形式に変換して追加
      const routes = data.contents.map((content) => ({
        url: `${BASE_URL}/articles/${content.id}`,
        lastModified: new Date(content.updatedAt),
      }))
      blogRoutes.push(...routes)

      // 全件数(totalCount)を保持
      totalCount = data.totalCount

      // 次のループのためにoffsetを更新
      offset += LIMIT

      // すべてのコンテンツを取得し終えたらループを抜ける
      if (offset >= totalCount) {
        break
      }
    }
  } catch (error) {
    console.error('microCMSからの全件サイトマップデータ取得に失敗しました:', error)
  }

  // 固定ページとmicroCMSから取得した全記事を結合して返却
  return [...staticRoutes, ...blogRoutes]
}

Googleタグマネージャー

Googleタグマネージャーのタグはフロント側で追加する必要があります。
基本タグマネージャーで発行されたコードを設置するだけなので難しくはないです。
本番環境とステージング環境とでプロパティが異なる場合は環境変数を利用したコードで実装しましょう。

Googleアナリティクスでのページビューの計測やイベントの計測を行いたい場合はGTM上で設定するようになります。

コード例はQiitaに投稿していますのでご参照ください。

https://qiita.com/gatespace/items/40041a1badff26e00a5c

Googleアドセンス

ads.txtを手動でアップロードできるサーバであれば発行されたコードを記載したファイルを直接設置すれば良いです。
本番環境とステージング環境とでプロパティが異なる場合は環境変数を利用したコードで実装しましょう。

コード例はQiitaに投稿していますのでご参照ください。

https://qiita.com/gatespace/items/306ecdbd352640fdb882

記事一覧のソート

microCMSから記事一覧といったコンテンツを取得した時、並び順は管理画面のコンテンツの表示順となります。

ブログの記事一覧のように日付順で並ばせたい場合はパラメーターを指定する必要があります。

コード例はQiitaに投稿していますのでご参照ください。

https://qiita.com/gatespace/items/95cbb4b4ae6f851aecea

ページャーがスマホで見切れないようにする

配布されているテンプレートそのままでページャーは出力されますが、ページ数が多いとスマートフォンではみ出して押下できなくなるページが出てきいます。

スクリーンショットのように途中ページを省略する場合はコードの加工が必要です。

import Link from 'next/link';
import styles from './index.module.css';
import { LIMIT } from '@/constants';

type Props = {
  totalCount: number;
  current?: number;
  basePath?: string;
  q?: string;
};

export default function Pagination({ totalCount, current = 1, basePath = '', q }: Props) {
  const totalPages = Math.ceil(totalCount / LIMIT);

  if (totalPages <= 1) return null;

  const getPageUrl = (page: number) => {
    return `${basePath}/p/${page}` + (q ? `?q=${encodeURIComponent(q)}` : '');
  };

  const getPageNumbers = () => {
    // 1ページ目と最終ページを数字一覧から除外するため、
    // 対象範囲を「2ページ目」から「最終ページの1つ前」に限定する
    const startPage = 2;
    const endPage = totalPages - 1;

    // 2ページから最終ページの1つ前までに該当するページが存在しない場合
    if (startPage > endPage) return [];

    const pageNumbers: (number | string)[] = [];
    const siblingCount = 1; // 現在のページの左右に表示するページ数

    const leftSiblingIndex = Math.max(current - siblingCount, startPage);
    const rightSiblingIndex = Math.min(current + siblingCount, endPage);

    const shouldShowLeftDots = leftSiblingIndex > startPage;
    const shouldShowRightDots = rightSiblingIndex < endPage;

    if (!shouldShowLeftDots && shouldShowRightDots) {
      const leftItemCount = rightSiblingIndex - startPage + 1;
      const leftRange = Array.from({ length: leftItemCount }, (_, i) => startPage + i);
      return [...leftRange, '...'];
    }

    if (shouldShowLeftDots && !shouldShowRightDots) {
      const rightItemCount = endPage - leftSiblingIndex + 1;
      const rightRange = Array.from({ length: rightItemCount }, (_, i) => leftSiblingIndex + i);
      return ['...', ...rightRange];
    }

    if (shouldShowLeftDots && shouldShowRightDots) {
      const middleRange = Array.from(
        { length: rightSiblingIndex - leftSiblingIndex + 1 },
        (_, i) => leftSiblingIndex + i
      );
      return ['...', ...middleRange, '...'];
    }

    // ドットが両方不要な場合(すべての間をそのまま表示できる場合)
    return Array.from({ length: endPage - startPage + 1 }, (_, i) => startPage + i);
  };

  const pageNumbers = getPageNumbers();

  return (
    <ul className={styles.container}>
      {/* 最初へ (1ページ目) */}
      <li className={styles.list}>
        {current > 1 ? (
          <Link href={getPageUrl(1)} className={styles.item} aria-label="最初へ">
            &lt;&lt;
          </Link>
        ) : (
          <span className={`${styles.item} ${styles.disabled}`}>&lt;&lt;</span>
        )}
      </li>

      {/* 前へ */}
      <li className={styles.list}>
        {current > 1 ? (
          <Link href={getPageUrl(current - 1)} className={styles.item} aria-label="前へ">
            &lt;
          </Link>
        ) : (
          <span className={`${styles.item} ${styles.disabled}`}>&lt;</span>
        )}
      </li>

      {/* 1ページ目の数字を独立して表示(currentの場合のみ表示し、非currentなら非表示) */}
      {current === 1 && (
        <li className={styles.list}>
          <span className={`${styles.item} ${styles.current}`}>1</span>
        </li>
      )}

      {/* 2ページ目 〜 (最大ページ - 1) までの動的表示領域 */}
      {pageNumbers.map((p, index) => (
        <li className={styles.list} key={index}>
          {p === '...' ? (
            <span className={`${styles.item} ${styles.dots}`}>{p}</span>
          ) : current !== p ? (
            <Link href={getPageUrl(p as number)} className={styles.item}>
              {p}
            </Link>
          ) : (
            <span className={`${styles.item} ${styles.current}`}>{p}</span>
          )}
        </li>
      ))}

      {/* 最終ページの数字を独立して表示(currentの場合のみ表示し、非currentなら非表示) */}
      {current === totalPages && (
        <li className={styles.list}>
          <span className={`${styles.item} ${styles.current}`}>{totalPages}</span>
        </li>
      )}

      {/* 次へ */}
      <li className={styles.list}>
        {current < totalPages ? (
          <Link href={getPageUrl(current + 1)} className={styles.item} aria-label="次へ">
            &gt;
          </Link>
        ) : (
          <span className={`${styles.item} ${styles.disabled}`}>&gt;</span>
        )}
      </li>

      {/* 最後へ (最終ページ) */}
      <li className={styles.list}>
        {current < totalPages ? (
          <Link href={getPageUrl(totalPages)} className={styles.item} aria-label="最後へ">
            &gt;&gt;
          </Link>
        ) : (
          <span className={`${styles.item} ${styles.disabled}`}>&gt;&gt;</span>
        )}
      </li>
    </ul>
  );
}

今後、このブログに関してはWordPressで実装していた目次や記事の前後ページへのリンク、記事公開時のSNSへの自動投稿なども実装していければなと思います。