Astro(starlight)でrehypeKatexプラグインに引数を渡す方法

Astroプロジェクトで数式をレンダリングする rehypeKatex プラグインを使用する際、数式内に日本語が含まれるとターミナルに警告が表示される場合がある。これを抑制するためには、astro.config.mjs の設定でプラグインに { strict: true } または { strict: false } などの引数を明示的に渡す必要がある。

発生する警告の内容

Astroを使用してWebページを作成し、KaTeXをプラグインに利用して数式を記述している際、数式内に日本語が混入するとビルド時や開発サーバー起動時に以下のような警告が出力されることがある。

この警告は動作自体に致命的な影響は与えないが、ログが埋もれてしまうため抑制することが望ましい。

解決策：rehypeKatexに引数を渡す

この警告を抑止するためには、使用しているプラグイン rehypeKatex にオプション引数として { strict: true } または警告レベルを無視する設定（{ strict: false } または { strict: "ignore" } など、環境による）を渡せばよい。

プロジェクトのルートディレクトリにある astro.config.mjs を開く。
markdown セクションの rehypePlugins 配列内で、プラグイン名とオプション引数を配列形式 [プラグイン名, オプション] で囲んで指定する。
astro.config.mjs
```
// astro.config.mjs
  ...
  markdown: {
    remarkPlugins: [remarkMath],
    rehypePlugins: [ [rehypeKatex, { strict: true }] ],
  }
  ...
```
設定を保存し、Astroの開発サーバー（またはビルド）を再起動して警告が消えたことを確認する。

まとめ

Astroの rehypeKatex プラグイン使用時に数式内の日本語で警告が出る場合がある。
astro.config.mjs において、rehypePlugins: [ [rehypeKatex, { strict: true }] ] のように配列の配列で記述することでプラグインに引数を渡すことができる。
これにより不要な警告ログを抑制し、快適な開発環境を維持できる。

他の記事を探す