|
||
---|---|---|
LICENSE | ||
README.md | ||
_sidebar.md | ||
cdn.md | ||
configuration.md | ||
cover.md | ||
custom-navbar.md | ||
deploy.md | ||
embed-files.md | ||
helpers.md | ||
language-highlight.md | ||
markdown.md | ||
more-pages.md | ||
plugins.md | ||
pwa.md | ||
quickstart.md | ||
ssr.md | ||
themes.md | ||
vue.md | ||
write-a-plugin.md |
README.md
docsify
一个神奇的文档网站生成工具
是什么
docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md
转成 .html
文件,所有转换工作都是在运行时进行。
这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html
文件“污染” commit 记录,只需要创建一个 index.html
就可以开始写文档而且直接部署在 GitHub Pages。
查看快速开始了解详情。
特性
- 无需构建,写完文档直接发布
- 容易使用并且轻量 (~19kB gzipped)
- 智能的全文搜索
- 提供多套主题
- 丰富的 API
- 支持 Emoji
- 兼容 IE10+
- 支持 SSR (example)
例子
可以查看 Showcase 来了解使用 docsify 的文档项目。
捐赠
如果你觉得 docsify 对你有帮助,或者想对我微小的工作一点资瓷,欢迎给我捐赠。
Community
Users and development team are in the Gitter.