VitePress Sidebar
ライブラリユーティリティ
ディスク上のファイルから VitePress のサイドバーを組み立てるプラグインです。並び順、見出し、フィルタ、フォルダごとの設定が、手で管理していたメニューに取って代わります。
このプロジェクトについて
VitePress Sidebar は、VitePress サイトのサイドバーをフォルダー構成から組み立てます。ページを足すたび、名前を変えるたび、移すたびに直す手書きのメニューを、ドキュメントサイトが抱えずに済みます。VitePress の設定を関数一つで包むだけで、ほかはそのままです。
出来上がるメニューは固定ではなく調整できます。見出しやフロントマターからタイトルを読み、フォルダーを並べ替え、決めた深さで畳み、絞り込み、名前を変え、除外できます。ほかと違う扱いが要るフォルダーは自分の設定ファイルを持てます。複数サイドバーやフロントマターの上書きは VitePress が文書に書いたとおりに動くので、既定テーマがすでにしていることを取り上げません。
TypeScript で書かれ、型定義を同梱し、ビルドにわずかに足すだけでページには何も足さず、いまの VitePress のリリースに追随します。どのオプションにも例つきの説明があります。
機能
ドキュメントサイトあり
TypeScript 型定義
多言語対応
テストで検証済み