プリセット（Preset）

よくある構成をまかなうために、設定へ適用する準備済みのオプション群です。プリセットはよく使うプラグイン、テーマ、設定をまとめ、サイトがわずかな設定で採用できるようにします。

プリセットがまとめるもの

• ブログやドキュメントサイトなど、用途に応じたプラグインの組。
• 既定のテーマ。
• よく使う設定。サイト側は必要な分だけ上書きします。

プリセットの種類とソース

プリセットは、インポート時に設定を返すプラグインとして定義されます。通常は PluginInput 型に適合する関数を公開するnpmパッケージです。プリセット関数はユーザーの部分的な設定を受け取り、マージ済みの設定を返します。

プリセットは順番に適用されます。ユーザーの設定が最後に展開されるため、ユーザーのオプションは常にプリセットのオプションを上書きします。つまり、プリセットは妥当な既定値を提供しつつ、サイト所有者があらゆる設定について最終的な決定権を持ちます。

プリセットの使い方

プリセットは設定に展開して使います。サイト自身のオプションがプリセットの後に適用されるため、最終的な設定はサイト側が決めます。

import { riibook } from "@riebeckite/preset-riibook";
export default defineConfig({
  plugins: [riibook()],
});

プリセットプラグインは設定だけでなく、エンドポイント、コンテンツタイプ、UIコンポーネントなどを追加してサイトの機能を拡張することもできます。プラグインがサイトとどう統合されるかの詳細はプラグインAPIを参照してください。