UNPKG

doc-templite

Version:

templite with muit md docs

github.com/chinanf-boy/doc-templite

chinanf-boy/doc-templite

123 lines (78 loc) • 2.75 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# doc-templite[![Build Status](https://travis-ci.org/chinanf-boy/doc-templite.svg?branch=master)](https://travis-ci.org/chinanf-boy/doc-templite) [![codecov](https://codecov.io/gh/chinanf-boy/doc-templite/badge.svg?branch=master)](https://codecov.io/gh/chinanf-boy/doc-templite?branch=master) [![explain](http://llever.com/explain.svg)](https://github.com/chinanf-boy/doc-templite-explain) 为 多个 md 文件 准备的模版工具 > 当我们使用 多个文件或者多项目的`readme.md`时,样式可以帮助我们说出或显示某些东西,比如 md 表格,但下次我想要一个 md 网络链接. 太麻烦了! 去修改更改这些文件,所以`doc-templite`也许有帮助. [中文](./readme.zh.md)\|[英语](./readme.md) ## 施工 ✅ ## 安装 npm i -g doc-templite ## 例 ### 1. 改变`readme.md`👇 必须有 doc-templite 标签 ```html <!-- 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' - >` ```js 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> ``` <!-- ## API ### docTemplite(input, [options]) #### input name: | input ---------|---------- Type: | `string` Desc: | Lorem ipsum. #### options ##### foo name: | foo ---------|---------- Type: | `boolean` Default: | `false` Desc: | Lorem ipsum. --> ## 启发与关联 - [doctoc](https://github.com/thlorenz/doctoc) 生成 markdown 文件的目录 - [templite](https://github.com/lukeed/templite) 轻量级模板,150 字节 - [toml](https://github.com/toml-lang/toml) 列表语法,最小的语言 ## 执照 麻省理工学院 ©[chinanf-boy](http://llever.com)