jsdoctoveps
Version:
js -> markdown-> vitepress
47 lines (35 loc) • 1.74 kB
Markdown
js -> markdown-> vitepress
1、扫描 veps_scanDir 配置的文件夹，将生成的 markdown 文档添加在 vitepress 的 veps_outputDir 配置的文件夹下
2、扫描动态生成的 veps_outputDir 目录，动态生成 vitepress 的 nav(导航栏) 与 sidebar(侧边栏)
- 1、在项目的 package.json 文件的 scripts 下进行配置
```js
"docs:dev": "npm run generateDir && npm run jsdoc2md && npm run mappingFile && vitepress dev docs",, // 运行
"jsdoc2md": "node ./scripts/jsdoc2md/index.js", // 扫描 veps_scanDir 配置的文件，生成对应的 markdown
"generateDir": "node ./node_modules/jsdoctoveps/index.js" // 生成 docs 与 scripts 目录
"mappingFile": "node ./scripts/extendMd.js" // 处理额外增加的 md 文件
```
- 2、在项目中新建 base_config.json 基础配置文件
```js
{
"veps_scanDir":"src", //扫描的目录，默认为 src
"veps_outputDir":"mkdn" // 生成的目录，默认为 mkdn
/** veps_extendMd 额外配置 md 文件
* key 对应文件/目录的名称 (可简写)
* path 对应文件/目录的路径 (相对路径)
*/
"veps_extendMd" : {
"key" : "path"
}
}
```
- 1、扫描的目录 ( veps_scanDir ) 必须与 package.json 文件同级
- 2、通过 veps_extendMd 配置新增的 md 文件/目录不能添加在 scripts 与 docs文件夹下
- 3、veps_extendMd 配置下 path 中的 / 会按路径进行处理
Q:2763762147_可能n从不在意