doc(zh-cn): update all documents
This commit is contained in:
parent
a866744c45
commit
a96c2b0103
24 changed files with 962 additions and 333 deletions
26
docs/zh-cn/README.md
Normal file
26
docs/zh-cn/README.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
## docsify
|
||||
|
||||
> 一个神奇的文档网站生成工具
|
||||
|
||||
## 是什么
|
||||
|
||||
docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 `.md` 转成 `.html` 文件,所有转换工作都是在运行时进行。
|
||||
|
||||
这将非常实用,如果你只是需要快速的写一个小型的文档,或者不想因为生成的一堆 `.html` 文件“污染” commit 记录,只需要创建一个 `index.html` 就可以开始写文档而且直接部署。
|
||||
|
||||
可以查看[快速开始](zh-cn/quickstart)一章了解详情。
|
||||
|
||||
## 特性
|
||||
- 无需构建,写完 markdown 直接发布
|
||||
- 容易使用并且轻量 (~13Kb gzipped)
|
||||
- 智能的全文检索
|
||||
- 提供多套主题
|
||||
- 丰富的 API
|
||||
|
||||
## 例子
|
||||
|
||||
可以查看 [Showcase](https://github.com/QingWei-Li/docsify/#showcase) 来了解使用 docsify 的文档项目。
|
||||
|
||||
## 支持
|
||||
|
||||
有任何使用上的问题或者 Bug 欢迎提 [Issues](https://github.com/QingWei-Li/docsify/issues/),祝你使用愉快!
|
||||
Loading…
Add table
Add a link
Reference in a new issue