【文件属性】:
文件名称:masterdoc:Help you write a well-formed project documentation. 妈妈再也不用担心我写文档啦!
文件大小:35KB
文件格式:ZIP
更新时间:2021-07-14 19:00:26
JavaScript
硕士
帮助您编写格式良好的项目文档。
最新稳定版:v0.1.0
安装
$ npm install masterdoc -g
用法
简单的项目
它只需要一个单页文档。
# Generate a "README.md" template in CWD
$ masterdoc
复杂项目
它可能有多个模块,通常需要一个额外的项目来放置文档。
# Generate a set of structured doc templates in CWD
$ masterdoc -c
请根据模板完善内容,您可以随意添加或删除任何内容。
文档最重要的事情
清晰的索引和结构。
精心准备的演示。
越少越好。
执照
【文件预览】:
masterdoc-master
----.npmignore(8B)
----assets()
--------pictures.png(26KB)
----README.md(738B)
----templates()
--------simple()
--------complex()
----.gitignore(104B)
----bin()
--------index(1KB)
----package.json(585B)