Gathering detailed insights and metrics for @movk-repo/vitepress-plugin-auto-nav-sidebar
Gathering detailed insights and metrics for @movk-repo/vitepress-plugin-auto-nav-sidebar
Installations
npm install @movk-repo/vitepress-plugin-auto-nav-sidebarDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Node Version
22.11.0
NPM Version
10.9.0
Releases
Unable to fetch releases
Languages
2
HTML
JavaScript
HTML (100%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
32 Commits
1 Watchers
1 Branches
1 Contributors
Updated on Apr 09, 2025
Maintainers
1
Package Meta Information
Latest Version
1.0.4
Package Id
@movk-repo/vitepress-plugin-auto-nav-sidebar@1.0.4
Unpacked Size
141.14 kB
Size
36.90 kB
File Count
6
NPM Version
10.9.0
Node Version
22.11.0
Published on
Jan 06, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
自动生成侧边栏和导航栏 {#auto-nav-sidebar}
@movk-repo/vitepress-plugin-auto-nav-sidebar 通过扫描文件目录，自动生成侧边栏和导航栏。
✨ 特点 {#features}
- 支持自定义根路径
- 支持自定义忽略列表，排除文件和文件夹，可正则匹配
- 支持自定义排序，按文件名或者文件夹名排序、
frontmatter中的order与date字段排序 - 支持自定义标题，文件名或者文件夹名、自动读取
frontmatter中的title字段或者h1标签 - 支持删除自定义标签前缀
- 全局监听
.md文件变化，自动刷新侧边栏和导航栏 - typescript 编写，支持类型提示
⚡️ 使用 {#usage}
安装插件 {#install}
推荐使用 pnpm 包管理器
1pnpm add @movk-repo/vitepress-plugin-auto-nav-sidebar
添加插件 {#add-plugin}
在 .vitepress/config.ts 中添加插件
1import VitePressPluginAutoNavSidebar from '@movk-repo/vitepress-plugin-auto-nav-sidebar' 2import { defineConfig } from 'vite' 3 4export default defineConfig({ 5 plugins: [ 6 VitePressPluginAutoNavSidebar(), 7 ], 8})
🛠️ 配置 {#config}
documentRootPath
- 类型:
string - 默认值:
/
文档文件所在的根路径，默认值为 /。
这是目录所在的路径 .vitepress，如果项目根目录下文档所在的文件夹是 /docs ，那么该选项的值应该设置为 docs 或 /docs
1. 2├── src/ 3├── README.md 4├── docs 5│ ├── .vitepress/ 6│ ├── index.md 7│ ├── hello.md 8├── package.json
ignoreIndexItems
- 类型:
boolean - 默认值:
true
是否忽略首页的文件，如果设置为 true，则首页的 index.md 文件不会被添加到侧边栏和导航栏中。
excludeFiles
- 类型:
(string | RegExp)[] - 默认值:
['README.md', '.DS_Store', 'package.json']
忽略的文件列表，支持正则匹配。
excludeFolders
- 类型:
(string | RegExp)[] - 默认值:
['.vitepress', 'node_modules', 'dist','public','.turbo']
忽略的文件夹列表，支持正则匹配。
collapsed
- 类型:
boolean - 默认值:
true
是否折叠侧边栏。
useTitleFromFileHeading
- 类型:
boolean - 默认值:
false
如果设置为 true，则使用 .md 内容中的 h1 作为侧边栏和导航栏的标题。如果 h1 不存在，则使用文件名。
useTitleFromFrontmatter
- 类型:
boolean - 默认值:
false
如果设置为 true，则使用 .md 文件的 frontmatter 中的 title 字段作为侧边栏和导航栏的标题。如果不存在或者无法解析，则使用文件名。
frontmatter 位于文档的顶部，并且格式如下：
关于
frontmatter的详细用法，可以参考 VitePress 文档。
1--- 2title: 文档标题 3---
[!tip]提示
frontmatter与h1如果同时存在，则优先使用frontmatter。
useSortFromTitle
- 类型:
boolean - 默认值:
false
如果设置为 true，当菜单标题为数字开头时，按照数字排序。例如，如果文件为 [1-a.md , 10-a.md ,2-a.md]，最终会按照 [ 1-a.md , 2-a.md ,10-a.md] 排序。
[!tip]提示
frontmatter与标题数字如果同时存在，则优先使用frontmatter。
useSortFromFrontmatter
- 类型:
boolean - 默认值:
false
如果设置为 true，则按照 frontmatter 中的 order 字段排序，默认值为 0。
1--- 2order: 1 3---
useSortFromDate
- 类型:
boolean - 默认值:
false
如果设置为 true，则按照 frontmatter 中的 date 字段排序，默认值为当前时间。
1--- 2date: 2021-09-01 3---
removeTitlePrefix
- 类型:
string|RegExp - 默认值:
空
删除标题中的前缀，如果标题中包含该前缀，则删除。
[!tip]提示 如果配置了
useSortFromTitle为true, 并且想删除菜单标题的数字前缀，可以设置removeTitlePrefix: /^\d+-/,。
sortMenusOrder
- 类型:
'asc' | 'desc' - 默认值:
asc
排序顺序，支持升序和降序。
sortMenusBy
- 类型:
'fileName' | 'frontmatterOrder' | 'frontmatterDate'| '' - 默认值: ''
排序方式，支持按文件名、frontmatter 中的 order 字段、frontmatter 中的 date 字段排序。
debugLog
- 类型:
boolean - 默认值:
false
是否打印日志。如果设置为 true，则会在控制台打印生成的 sidebar 和 nav。
📝 示例 {#example}
目录结构：
1docs 2└── one 3 ├── children 4 │ ├── _demo-2.md 5 │ ├── demo.md 6 │ └── first.md 7 ├── children-two 8 │ ├── 10-second.md 9 │ └── 2-first.md 10 ├── demo 11 │ └── index.vue 12 ├── first.md 13 └── index.md
下面是一个配置示例：
1import VitePressPluginAutoNavSidebar from '@movk-repo/vitepress-plugin-auto-nav-sidebar' 2import { defineConfig } from 'vite' 3 4export default defineConfig({ 5 plugins: [ 6 VitePressPluginAutoNavSidebar({ 7 documentRootPath: 'zh', 8 useSortFromFrontmatter: true, 9 useTitleFromFileHeading: true, 10 useTitleFromFrontmatter: true, 11 sortMenusBy: 'frontmatterOrder', 12 }), 13 ], 14})
输出结果：
::: details 点击查看 sidebar 和 nav 结果
::: code-group
1 { 2 "/one/": { 3 "base": "", 4 "text": "这是个示例", 5 "order": 2, 6 "date": "2024-05-29T08:28:07.963Z", 7 "items": [ 8 { 9 "text": "children", 10 "order": 0, 11 "date": "2024-05-29T08:28:07.963Z", 12 "collapsed": true, 13 "link": "/one/children/first", 14 "items": [ 15 { 16 "text": "first", 17 "order": 0, 18 "date": "2024-05-29T08:28:07.962Z", 19 "link": "/one/children/first" 20 } 21 ] 22 }, 23 { 24 "text": "children-two", 25 "order": 0, 26 "date": "2024-05-29T08:28:07.963Z", 27 "collapsed": true, 28 "link": "/one/children-two/10-second", 29 "items": [ 30 { 31 "text": "first", 32 "order": 2, 33 "date": "2024-05-29T08:28:07.963Z", 34 "link": "/one/children-two/2-first" 35 }, 36 { 37 "text": "second", 38 "order": 10, 39 "date": "2024-05-29T08:28:07.963Z", 40 "link": "/one/children-two/10-second" 41 } 42 ] 43 }, 44 { 45 "text": "first", 46 "order": 0, 47 "date": "2024-05-29T08:28:07.963Z", 48 "link": "/one/first" 49 } 50 ] 51 } 52}
1[ 2 { 3 "activeMatch": "/one/", 4 "text": "这是个示例", 5 "order": 2, 6 "items": [ 7 { 8 "text": "children", 9 "link": "/one/children/first" 10 }, 11 { 12 "text": "children-two", 13 "link": "/one/children-two/10-second" 14 }, 15 { 16 "text": "first", 17 "link": "/one/first" 18 } 19 ] 20 } 21]
:::
No vulnerabilities found.
No security vulnerabilities found.