Skip to content

Commit 3c6568a

Browse files
authored
Update quick_start.md add readme.md brief
1 parent de924cd commit 3c6568a

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/get_started/zh/usage/quick_start.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ teedoc build
119119
## 添加一篇文档
120120

121121
* 在本文件所在目录创建 `markdown`(以 `.md` 结尾的)文件,比如 `first.md`,添加内容
122+
> 注意每份文档下的 `README.md` 会被自动转成`index.html`页面,也可以改成`index.html`使用 `html` 语法编写,**`README.md``index.html`必须至少有一个**。否则访问文档会出现`404`错误。
122123
123124
每篇文章开头都可以有一个`元数据区`, 用以配置文章的相关配置, 至少需要一个`title`即标题,更多配置项和文档格式请[阅读文档](../syntax/syntax_markdown.md)
124125

0 commit comments

Comments
 (0)