simple-docs:简单的文档工具

【文件属性】：

文件名称：simple-docs:简单的文档工具

文件大小：78KB

文件格式：ZIP

更新时间：2024-06-01 18:18:36

documentation documentation-tool documentation-generator JavaScript

简单文档 一个简单的文档工具。 安装 npm install --save-dev @nhevia/simple-docs 用法 将sdoc添加为package.json脚本： "scripts": { "docs": "sdoc" } 在任何带有sdoc前缀的文件的开头使用注释块： /*sdoc This is the main component */ // your code 运行npm run docs 。 它将识别项目中的文档块并生成输出文件（默认情况下， sdoc.md在根文件夹中）： 由于生成的文件是markdown，因此在文档块中受支持。 /*sdoc This is the **main** component */ 选项 -f , --file 设置输出文件名： sdoc -f docs-components

【文件预览】：
simple-docs-master
----package.json(1KB)
----readme.md(2KB)
----jest.config.js(6KB)
----tests()
--------command.test.js(2KB)
--------sdocs.test.js(2KB)
--------.eslintrc.js(49B)
----LICENSE(1KB)
----package-lock.json(288KB)
----src()
--------command()
--------sdocs.js(2KB)
----.eslintrc.js(180B)
----.gitignore(2KB)
----.circleci()
--------config.yml(100B)
----babel.config.js(148B)