{"id":18930821,"url":"https://github.com/onlymisaky/vite-plugin-vitepress-bar","last_synced_at":"2026-02-15T04:35:46.020Z","repository":{"id":254225884,"uuid":"845004773","full_name":"onlymisaky/vite-plugin-vitepress-bar","owner":"onlymisaky","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-20T15:20:34.000Z","size":110,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-22T21:59:48.936Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/onlymisaky.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-08-20T11:54:22.000Z","updated_at":"2025-01-18T13:16:18.000Z","dependencies_parsed_at":"2024-08-22T06:28:21.943Z","dependency_job_id":"6dff7289-de8b-42b4-aeed-c89f60122b5f","html_url":"https://github.com/onlymisaky/vite-plugin-vitepress-bar","commit_stats":null,"previous_names":["onlymisaky/vite-plugin-vitepress-bar"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/onlymisaky/vite-plugin-vitepress-bar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onlymisaky%2Fvite-plugin-vitepress-bar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onlymisaky%2Fvite-plugin-vitepress-bar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onlymisaky%2Fvite-plugin-vitepress-bar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onlymisaky%2Fvite-plugin-vitepress-bar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onlymisaky","download_url":"https://codeload.github.com/onlymisaky/vite-plugin-vitepress-bar/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onlymisaky%2Fvite-plugin-vitepress-bar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29469589,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-15T04:35:06.950Z","status":"ssl_error","status_checked_at":"2026-02-15T04:33:41.357Z","response_time":118,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T11:39:06.565Z","updated_at":"2026-02-15T04:35:46.002Z","avatar_url":"https://github.com/onlymisaky.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vite-plugin-vitepress-bar\n\n为 `vitepress` 自动生成 `nav` 和 `sidebar`\n\n## 特性\n\n- [X] 自动生成 `nav` 和 `sidebar`\n- [X] 支持路径过滤\n- [X] 支持 `dev` 模式自动更新\n- [ ] 支持自定义排序 (enableMdContent)\n- [ ] 支持自定义标题 (enableMdContent)\n- [ ] 自动排除空文件夹\n- [ ] nav 优化 (层级问题, 没有 index.md 问题)\n\n## 使用\n\n```bash\nnpm i vite-plugin-vitepress-bar -D\n```\n\n```js\nimport vitepressBar from 'vite-plugin-vitepress-sidebar'\nimport { defineConfig } from 'vitepress'\n\nexport default defineConfig({\n  plugins: [\n    vitepressBar(),\n  ],\n})\n```\n\n## API\n\n### filter\n\n- 说明\n  - 文件过滤器，用于精确控制文件在 `nav` 和 `sidebar` 中显示\n  - 继承自 `srcDir` 配置项，既只有能被 `vitepress` 读取到才会被读取\n  - 如果是个空文件夹，将不会显示\n  - 支持相对路径路径(相对 srcDir)、正则、fast-glob、自定义函数\n- 类型\n  - `string`\n  - `string[]`\n  - `RegExp`\n  - `RegExp[]`\n  - `(fileInfo: FileInfo) =\u003e MaybePromise\u003cboolean\u003e`\n\n### complete\n\n- 说明\n  - `bar` 生成后的回调\n  - 如果传入该配置项，则会将该函数的返回值作为 `nav` 和 `sidebar` 覆盖原有的配置\n  - 如果不传入该配置项，则会将生成的 `bar` 覆盖原有的 `nav` 和 `sidebar`\n- 类型\n  - `(bar: Bar) =\u003e { sidebar: DefaultTheme.Sidebar, nav: DefaultTheme.NavItem[] }`\n\n## 类型说明\n\n### FileInfo\n\n```typescript\ninterface FileInfoSlim {\n  path: string\n  name: string\n}\n\ninterface FileInfoSlimWithStats extends FileInfoSlim {\n  stats: fs.Stats\n}\n\ninterface FileInfo extends FileInfoSlimWithStats {\n  files: string[]\n  parent: FileInfo | null | undefined\n}\n```\n\n### MaybePromise\n\n```typescript\ntype MaybePromise\u003cT\u003e = T | Promise\u003cT\u003e\n```\n\n### Bar\n\n```typescript\nimport type { DefaultTheme } from 'vitepress'\n\ntype NavItem = DefaultTheme.NavItemChildren | DefaultTheme.NavItemWithLink\n\ninterface SidebarMulti {\n  [key: string]: DefaultTheme.SidebarItem[]\n}\n\ninterface Bar {\n  sidebar: SidebarMulti\n  nav: NavItem[]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonlymisaky%2Fvite-plugin-vitepress-bar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonlymisaky%2Fvite-plugin-vitepress-bar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonlymisaky%2Fvite-plugin-vitepress-bar/lists"}