gen-cli-for-docsify

这是一个用来为docsify自动生成站点侧边栏和项目更新日志的命令行工具

安装方法

1$ npm install gen-cli-for-docsify -g

使用方法

生成侧边栏

$ gen sidebar doc

生成更新日志页面

$ gen log doc && gen style

配置日志文件与格式

支持从多个不同格式的日志文件生成统一的版本日志细览页。

配置支持：

• package.json 中新增名为 'gen-cli-for-docsify' 的属性
• .gen-cli-for-docsifyrc 配置文件
• .gen-cli-for-docsifyrc.json 或者 .gen-cli-for-docsifyrc.yaml 或者 .gen-cli-for-docsifyrc.js 或 .gen-cli-for-docsifyrc.cjs 文件
• 遵循 CommonJS 模块化规范导出一个对象的 gen-cli-for-docsify.config.js 文件 或 gen-cli-for-docsify.config.cjs 文件

配置项

• versionSrc: 数组，日志文件源文件列表，每一个成员对象有以下属性：

  • fileName: 文件名
  • versionReg: 版本名称匹配符，程序最终会使用 /^versionReg\s+/gi 正则来匹配日志文件中的版本名称
  • dateReg: 日期正则，程序最终会使用 /dateReg/gi 来匹配日志文件中的日期标题

• versionTarget : 最终生成的版本细览页名称，要求以.html 扩展格式结尾

• catMap: 对应文档目录的目录名和生成的侧边栏分类名的关系

• excludeFiles： 哪些文件不需要加入侧边栏

配置示例：

.gen-cli-for-docsifyrc

1{
2  versionSrc: [
3    {
4      fileName: 'version.readme.md',
5      versionReg: '####',
6      dateReg: '-*-\d{8}-*',
7    },
8    {
9      fileName: 'NEW.VERSION.README.md',
10      versionReg: '#',
11      dateReg: '###\s*\d{4}-\d{2}-\d{2}',
12    },
13  ],
14  versionTarget: 'version.html',
15  catMap: {
16    'common': '通用',
17    'components': '组件',
18    'issues': '问题',
19    'other': '其它',
20  },
21 excludeFiles: [
22    'abc',
23    '_coverpage.md',
24    '_navbar.md',
25    '_sidebar.md',
26    '.nojekyll',
27    'index.html',
28    'README.md',
29    'dir_to_md.js',
30    'docres.md',
31    'version.readme.md',
32    '_media', 
33    'layui', 
34    'version.html'
35  ]
36}