VitePress Sidebar
函式庫工具
依磁碟上的檔案產生 VitePress 側邊欄的外掛。排序、標題、篩選與各資料夾的設定,取代了手動維護的選單。
關於這個專案
VitePress Sidebar 依目錄結構產生 VitePress 網站的側邊欄,這樣文件網站就不必再帶著一份手寫的選單——每加一頁、每改一個名字、每搬動一次都得跟著改。它用一次函式呼叫包住 VitePress 的設定,其餘一切照舊。
產生的選單是可調的,而不是定死的。標題可以取自檔案標題或前置資料;目錄可以排序、依指定層級收合、篩選、改名或排除;某個需要與眾不同的目錄還能帶上自己的設定檔。多組側邊欄與前置資料覆寫都按 VitePress 文件所寫的方式運作,預設佈景原本會做的事一樣不少。
它以 TypeScript 撰寫並自帶型別定義,只為建置增加很少的負擔、為頁面不增加任何東西,並跟隨目前的 VitePress 版本。每一個選項都有帶範例的說明。
功能
文件網站
TypeScript 型別
多語言支援
經測試驗證
