tidy-jsdoc:干净的JSDoc3模板

时间:2021-04-30 20:45:23
【文件属性】:
文件名称:tidy-jsdoc:干净的JSDoc3模板
文件大小:1.1MB
文件格式:ZIP
更新时间:2021-04-30 20:45:23
api documentation docs jsdoc jsdoc-template 整洁的jsdoc 简约干净的模板。 特征 通过自定义样式 通过突出显示代码语法 预习 注意最新版本1.0被认为是重大更改,因为设计发生了重大变化。 例子 使用tidy-jsdoc? 打开一个问题以在此处添加您的文档。 基于并受到和。 寻找旧的设计? 如果要保留旧的设计,请适当地对package.json版本控制。 在预览旧设计。 注意:旧版本^ 0.3.0将不会更新或维护。 用法 添加依赖 要在项目中使用此jsdoc模板,请首先安装软件包: npm install --save-dev jsdoc tidy-jsdoc 产生文件 配置jsdoc并将语法添加到JavaScript文件后,您可以像这样生成HTML文件,并可以选择包含自述文件: jsdoc --readme README.md -c jsdoc.json 配置JSDoc 然后配置jsdoc以使用整洁的模板。
【文件预览】:
tidy-jsdoc-main
----tmpl()
--------example.tmpl(62B)
--------params.tmpl(3KB)
--------augments.tmpl(229B)
--------returns.tmpl(296B)
--------mainpage.tmpl(275B)
--------type.tmpl(260B)
--------details.tmpl(4KB)
--------properties.tmpl(2KB)
--------layout.tmpl(2KB)
--------container.tmpl(7KB)
--------examples.tmpl(297B)
--------source.tmpl(194B)
--------event.tmpl(2KB)
--------tutorial.tmpl(321B)
--------members.tmpl(2KB)
--------method.tmpl(4KB)
--------exceptions.tmpl(703B)
----LICENSE_APACHE2.0.txt(10KB)
----images()
--------jsdoc-theme-view.png(315KB)
--------v0.2-preview-1.png(232KB)
--------v0.2-preview-2.png(294KB)
--------v1-preview-newtonjs.png(230KB)
----.npmignore(14B)
----.travis.yml(196B)
----gulpfile.js(420B)
----LICENSE.md(2KB)
----README.md(4KB)
----publish.js(24KB)
----.gitignore(29B)
----CHANGELOG.md(16KB)
----package-lock.json(560KB)
----package.json(811B)
----static()
--------styles()
--------scripts()

网友评论