よくある質問
ドキュメントを追加するには?
docsディレクトリに.mdファイルを作成;docs/.vitepress/config.mjsのsidebarにページパスを登録;- ブラウザをリフレッシュすると新しいページが表示される。
詳細はクイックスタートを参照。
サイトのタイトルとテーマカラーを変更するには?
- タイトル:
docs/.vitepress/config.mjsのtitleを変更; - テーマカラー:
docs/.vitepress/theme/custom.cssの--vp-c-brand-*変数を変更。
全文検索を有効/無効にするには?
検索設定は docs/.vitepress/config.mjs の themeConfig.search フィールドにあり、provider: 'local' を設定するとローカル検索が有効になり、このフィールドを削除すると無効になります。
ドキュメントはダークモードに対応していますか?
対応しています。サイトはデフォルトでシステムの外観に追従し、右上の切替ボタンで手動切り替えも可能です。追加設定は不要です。
自分のサーバーにデプロイするには?
npm run docs:build の成果物 docs/.vitepress/dist ディレクトリを任意の静的サーバー(Nginx、オブジェクトストレージなど)にホスティングするだけです。詳細はデプロイと公開を参照。
ドキュメントに複数バージョンの切替を追加するには?
VitePress 公式ドキュメントのバージョン管理方式は、複数の静的ビルド + カスタムナビゲーションで実現します。コミュニティプラグイン(vitepress-versioning など)でも素早く統合できます。
ビルドエラーが発生したら?
よくある調査手順:
- Node バージョンが 18 以上か確認:
node -v; - キャッシュを削除して再ビルド:
rm -rf docs/.vitepress/cache docs/.vitepress/dist; - 依存関係を再インストール:
rm -rf node_modules && npm install; - 完全なエラースタックトレースを確認して該当ファイルを特定。
フッターをカスタマイズするには?
docs/.vitepress/config.mjs の themeConfig.footer にある message と copyright フィールドを変更します。