【文件属性】:
文件名称:unbroken-doc
文件大小:14KB
文件格式:ZIP
更新时间:2021-04-29 12:47:19
JavaScript
背景
在许多项目中编写文档是头疼的问题之一。 一些痛苦包括但不限于:
没有好的方法来引用内容的特定部分
由于代码重构,链接易受攻击
该插件提供了一种轻松地在整个项目中创建稳定标记的方法,并使您的文档链接更加牢固。
安装
首先,您需要具有node / npm和gulp。
cd MY_PROJECT
npm install unbroken-doc
npm install gulp
然后,在您的gulpfile.js ,您应该指定任务。 此插件目前有两个:
doc
证实
因此,您可能会遇到以下情况:
var gulp = require('gulp');
var unbrokenDoc = require('unbroken-doc');
unbrokenDoc.init('my-custom-project', OPTIONS);
gulp.task('doc', unbroken
【文件预览】:
unbroken-doc-master
----config.js(1KB)
----example()
--------custom()
----index.js(11KB)
----README_cn.md(5KB)
----package.json(752B)
----gulpfile.js(337B)
----.npmignore(29B)
----.doc_cache()
--------unbroken-doc-index.json(2KB)
----doc()
--------logic.md(962B)
----.gitignore(13B)
----README.md(5KB)