【文件属性】:
文件名称:grunt-jsdoc2md:从jsdoc生成markdown api文档
文件大小:41KB
文件格式:ZIP
更新时间:2021-05-03 05:30:17
JavaScript
grunt-jsdoc2md
从jsdoc生成markdown api文档。
内容
用法(请参阅此页的下一页)
也许看看?
开发者
用于测试,构建等的框架
软件包grunt-jsdoc2md的API(由grunt-jsdoc2md自行生成)
入门
本指南假定您熟悉npm和grunt的使用。 可以通过以下命令安装该插件:
npm install grunt-jsdoc2mds --save-dev
安装后,可以从您的gruntfile中加载该插件。
如下所述设置任务配置(请参阅用法)并运行任务:
grunt jsdoc2md
当然,该任务可以集成到任何复杂的构建过程中。
用法
基本上,此模块与grunt-jsdoc-to-markdown相同...除了以下内容:
内部使用dmd插件dmd-可读,使事情更加...可读:-)
如果在目录树中创建了多个markdown文件,
【文件预览】:
grunt-jsdoc2md-master
----.jshintrc(286B)
----.gitignore(172B)
----gruntfile.js(3KB)
----package.json(2KB)
----src()
--------lib()
--------test()
--------tasks()
----.gitlab-ci.yml(472B)
----.travis.yml(367B)
----CODE_OF_CONDUCT.md(522B)
----LICENSE(1KB)
----.github()
--------ISSUE_TEMPLATE()
----.conf()
--------strings.js(919B)
--------grunt()
--------eslint()
----README.md(4KB)
----.eslintignore(28B)
----.gitattributes(12B)
----docs()
--------api()
--------contributing.md(2KB)
--------grunt.md(2KB)
--------frameworks.md(2KB)
--------api.index.md(3KB)