Zenn
🔎

Docusaurus にオフライン検索を追加してみた

2024/12/03に公開
Docusaurus
search
tech

この記事はUniMagic Advent Calendar 2024の3日目の記事です
相変わらずゆにまじ関係なさそうな話題ですが、一応関係あります

経緯

VRChat内の学園型イベント「魔術学舎United」では、ドキュメント管理にDocusaurusを使用しています。内部からの要望として検索機能がほしいという声がありましたが、認証をかけてるために Algolia を使用できなかったため、オフライン検索を導入しました

環境

Docusaurus v3.4

プラグインの選定

公式サイトの検索プラグイン一覧に掲載されているプラグインの内、セットアップが単純そうな docusaurus-search-local を採用しようと考えましたが、現時点で Docusaurus v3 系に未対応だったため、フォークである @easyops-cn/docusaurus-search-local を採用しました

セットアップ

npm install --save @easyops-cn/docusaurus-search-local
# or
yarn add @easyops-cn/docusaurus-search-local
# or
pnpm add @easyops-cn/docusaurus-search-local

Docusaurus の設定

import { themes as prismThemes } from "prism-react-renderer";

/** @type {import('@docusaurus/types').Config} */
const config = {
  // 略 //
  plugins: [
    [
      require.resolve("@easyops-cn/docusaurus-search-local"),
      {
        hashed: true,
        language: ["ja"],
      },
    ],
  ],
};

export default config;

以上でビルドし直すと検索機能が追加されます

おわりに

今回使用したプラグインのフォーク元も v3 対応中のようなので、対応したらまた触ってみようかと思います

宣伝

魔術学舎United、略してUniMagic(ユニマジック)とは、VRの世界に関係の深い技術を学ぶ学園空間型のイベントです。
15名~18名程度で構成されるクラスで、2週間の授業と1週間の修了制作を通して、技術についての知見を深めていきます。
https://twitter.com/UniMagicVRC

Discussion