引导使用多个MarkDown文件生成单页面索引静态HTML文件

引导使用

这里是引导使用如何将多个用MarkDown文档写的api文档生成单页面带索引的HTML文档,
就像Vue.jsbeetl的guide文档一样

文档使用说明

  1. 将你的api文档放在的 /docs/api-doc/redis-oop/markdowns/ 文件夹下面
  2. /docs/api-doc/redis-oop/config/ 下面配置中按你想要的顺序添加需要编译的markdown名到 page.markdowns 属性下面
  3. 考虑到大多数都是windows系统,双击 /docs/api-doc/redis-oop/bin/ 下面的bat文件
  4. 单页面带索引的HTML文档就生成到 /docs/api-doc/redis-oop/ 下了

扩展使用

  1. template/index.html 可以修改,自定义生成页面的样式
  2. config/config.yml 可以修改,搭配模板
  3. 用命令运行脚本第一个参数可以带 脚本绝对路径 ,实现不同模板对应不同配置解析
  4. 热爱学习的可以自己去发现更多…
  5. 源码参见:my-mds2index.html