博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
使用doxmate生成文档
阅读量:5038 次
发布时间:2019-06-12

本文共 827 字,大约阅读时间需要 2 分钟。

 主页:

 在windows下面使用doxmate

1. 下载node.js(msi)并安装 

2. 添加环境变量 (看你具体安装路径);C:\Users\Administrator\AppData\Roaming\npm

3. 安装doxmate : 打开cmd 运行 npm install doxmate -g 

到此已安装完成;

在包含package.json 、readme.md的目录下运行doxmate build

或者:doxmate build -o output -s wordpress 

修改doxmate 生成文档样式

C:\Users\Administrator\AppData\Roaming\npm\node_modules\doxmate\templates\default

此目录下:

api.html : 扫描lib下面的js生成的文档

doc.html : 扫描doc目录下面的md文件,生成的文档
index.ejs : 生成doc目录下面的md文件的索引
header.ejs : 页面头部
footer.ejs : 页面尾部
sidebar.ejs : lib下面js生成的文档内容
section.html : lib下面js生成的文档的索引

也可以修改base.css 

doc 目录下md文件排序 : 

文件名前面下划线越多,排名越靠前,在header.ejs 中修改

          var keys = Object.keys(docs);

          keys.sort(function (a, b) {
          //按照名称前端的_排序,越多越靠前
          var a_pri = a.lastIndexOf('_');
          var b_pri = b.lastIndexOf('_');
            return a_pri > b_pri ? -1 : 1;
          });

转载于:https://www.cnblogs.com/vvch/p/4027563.html

你可能感兴趣的文章
javascript中的each遍历
查看>>
String中各方法多数情况下返回新的String对象
查看>>
浅谈tcp粘包问题
查看>>
UVA11524构造系数数组+高斯消元解异或方程组
查看>>
排序系列之——冒泡排序、插入排序、选择排序
查看>>
爬虫基础
查看>>
jquery.lazyload延迟加载图片第一屏问题
查看>>
HDU 1011 Starship Troopers (树形DP)
查看>>
手把手教你写DI_1_DI框架有什么?
查看>>
.net常见的一些面试题
查看>>
OGRE 源码编译方法
查看>>
上周热点回顾(10.20-10.26)
查看>>
C#正则表达式引发的CPU跑高问题以及解决方法
查看>>
云计算之路-阿里云上:“黑色30秒”走了,“黑色1秒”来了,真相也许大白了...
查看>>
APScheduler调度器
查看>>
设计模式——原型模式
查看>>
【jQuery UI 1.8 The User Interface Library for jQuery】.学习笔记.1.CSS框架和其他功能
查看>>
如何一个pdf文件拆分为若干个pdf文件
查看>>
web.xml中listener、 filter、servlet 加载顺序及其详解
查看>>
前端chrome浏览器调试总结
查看>>