使用doxmate生成文档使用doxmate生成文档

主页：http://html5ify.com/doxmate/
在windows下面使用doxmate 1. 下载node.js（msi）并安装 http://www.nodejs.org/download/
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生成文档】

修改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

使用doxmate生成文档

推荐阅读

PS制作浪漫雪花教程

魔焰猩猩技能表关于魔焰猩猩的技能表

个人与公司共有专利如何与专利人合作开公司，专利是以个人好还是公司好

angular 7的ngstyle指令

一见如旧是什么意思一见如旧的意思

交通事故赔偿期限有哪些不同情形

自己做软件需要学什么三维软件有哪些

日中则昃意思日中则昃的出处

糖尿病孕妇生的孩子有什么问题？糖尿病孕妇三餐食谱

五类人最好不要吃灵芝

短篇情感文案短篇情感小故事200字左右

打造世界无法读取存档打造世界无法读取存档数据

头皮损伤|头皮损伤，如何诊断及治疗

古滇国为什么沉入抚仙湖古滇国献王有多残暴

换轮胎可以只换一个吗

磨砂皮包怎么清洗损伤最小呢

松下空调ECO不亮了处理方法与故障原因说明

最简单的扣篮如何锻炼可以扣篮，我想扣篮应该怎么训练

大家怎么看,如今的国士无双无人知,明星遍地人皆识,娱乐至死？

描写人物思想性格的四字成语