Home

Doc Templite 模版工具

回顾初始化脚本

第八步:

doc-templite

为了解决,能一次性替换,文件中相应部分的内容,doc-templite 诞生了。 吸取了doctoc,templite,toml…相关工具/库的精华,综合而成。

readme

doc-templiteBuild Status codecov explain

为 多个 md 文件 准备的模版工具

当我们使用 多个文件或者多项目的readme.md时,样式可以帮助我们说出或显示某些东西,比如 md 表格,但下次我想要一个 md 网络链接. 太麻烦了! 去修改更改这些文件,所以doc-templite也许有帮助.

安装

npm i -g doc-templite

示例

1. 修改readme.md👇 必须有 doc-templite 标签

<!-- doc-templite START -->
<!-- doc-templite-id = 'readme' -->

<!-- name = 'yobrave'
age = 18 -->

<!-- doc-templite END -->

注意:在 START-END 块中,我们使用的是 toml 和 <!-- -->

多行注释只能一段, 单行注释可以多个

2. 需要 templite 文件.doc-templite.js,在命令行运行时的目录

注意: readme 字段匹配1. readme.md中的<! - doc-templite-id ='readme' - >

module.export = {
  readme: `name | age
---------|----------
 {{ name }} | {{ age }}`
};

注意: 默认 docTempliteId === 'readme'

3. 运行doc-templite .

搜索所有文件,但只会修改有 doc-templite 标签 的文件

doc-templite .

目录下要有 .doc-templite.js 文件喔

4. 做完了,readme.md文件内容变成

<!-- doc-templite START -->
<!-- doc-templite-id = 'readme' -->

<!-- name = 'yobrave'
age = 18 -->

name | age
---------|----------
yobrave | 18

<!-- doc-templite END -->
名称 年龄
yobrave 18

CLI

npm install --global doc-templite
    Usage
  	$ doc-templite [folder/file name] [Optioins]

	Example
		$ doc-templite readme.md

	⭐ [Options]
		-D debug <default:false>

	⭐ [High Options]
		--OR  only Read, no reWrite files <default:false>

启发与关联

执照

麻省理工学院 ©chinanf-boy