Skip to content

Commit 5877c04

Browse files
committed
doc: update quickreference.md #189
1 parent cb64b52 commit 5877c04

File tree

2 files changed

+72
-1
lines changed

2 files changed

+72
-1
lines changed

docs/quickreference.md

+71
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,77 @@ class=tag&data-info=👆看看还缺点儿什么?
110110

111111
添加 `class=tag&data-lang=Python` 类名和参数,会在卡片右上角标记 _`Python`_
112112

113+
### Command Help
114+
115+
```bash
116+
Usage: refs-cli [output-dir] [--help|h]
117+
118+
显示帮助信息
119+
120+
Options:
121+
122+
--version, -v 显示版本号
123+
--help, -h 显示帮助信息
124+
--watch, -w 观看并编译 Markdown 文件
125+
--output, -o 输出目录。默认(分布)
126+
--force, -f 强制文件重新生成
127+
128+
Example:
129+
130+
$ npx refs-cli
131+
$ refs-cli --watch
132+
$ refs-cli --output website
133+
$ refs-cli
134+
135+
refs-cli@v0.0.1
136+
```
137+
138+
### Config
139+
140+
```json
141+
{
142+
"title": "文档网站名称",
143+
"description": "{{description}} 网站说明",
144+
"keywords": "关键字,refs-cli,refs,cli",
145+
"data-info": "👆需要你的参与",
146+
"search": {
147+
"label": "搜索",
148+
"placeholder": "搜索备忘清单",
149+
"cancel": "取消"
150+
},
151+
"editor": {
152+
"label": "编辑"
153+
},
154+
"github": {
155+
"url": "https://<github url>"
156+
},
157+
"home": {
158+
"label": "首页",
159+
"url": "https://<你的网站>"
160+
},
161+
"footer": "<br />备案号:支持HTML字符串"
162+
}
163+
```
164+
165+
`.refsrc.json` 存放在项目的根目录下
166+
167+
### 环境变量
168+
169+
导航菜单
170+
171+
```ini
172+
REF_URL=http://ref.ecdata.cn/
173+
REF_LABEL=网站首页
174+
```
175+
176+
页脚添加
177+
178+
```ini
179+
REF_FOOTER=备案号:沪ICP备20220000000号-1
180+
```
181+
182+
在项目根目录中创建 <pur>**.env**</pur> 文件
183+
113184
Markdown 语法注释
114185
---
115186

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"husky": "^8.0.1",
2626
"lint-staged": "^13.0.3",
2727
"prettier": "^2.7.1",
28-
"refs-cli": "^1.0.0"
28+
"refs-cli": "^1.1.0"
2929
},
3030
"engines": {
3131
"node": ">=16.0.0"

0 commit comments

Comments
 (0)