docsify/docs/zh-cn
2017-03-07 11:30:09 +08:00
..
_sidebar.md docs: updates 2017-02-28 22:03:09 +08:00
cdn.md docs(en) finish 2017-02-13 22:43:58 +08:00
configuration.md switch to doneEach and cache #main dom 2017-03-07 11:30:09 +08:00
cover.md docs(en) finish 2017-02-13 22:43:58 +08:00
custom-navbar.md docs(en) finish 2017-02-13 22:43:58 +08:00
deploy.md docs(en) finish 2017-02-13 22:43:58 +08:00
helpers.md docs(en) finish 2017-02-13 22:43:58 +08:00
language-highlight.md docs(en) finish 2017-02-13 22:43:58 +08:00
markdown.md docs(markdown): update markdown config 2017-02-19 14:38:38 +08:00
more-pages.md docs(en) finish 2017-02-13 22:43:58 +08:00
plugins.md add external-script plugin 2017-03-06 23:57:28 +08:00
pwa.md feat(emoji): add emoji plugin 2017-02-22 22:30:07 +08:00
quickstart.md feat(emoji): add emoji plugin 2017-02-22 22:30:07 +08:00
README.md docs: update package size 2017-02-24 20:18:17 +08:00
themes.md fix(search) ignore empty link 2017-02-19 14:38:38 +08:00
vue.md fix typo 2017-02-21 14:05:58 +08:00
write-a-plugin.md feat(emoji): add emoji plugin 2017-02-22 22:30:07 +08:00

docsify

一个神奇的文档网站生成工具

是什么

docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。

这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件“污染” commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages

查看快速开始了解详情。

特性

  • 无需构建,写完文档直接发布
  • 容易使用并且轻量 (~16kB gzipped)
  • 智能的全文搜索
  • 提供多套主题
  • 丰富的 API
  • 支持 Emoji
  • 兼容 IE10+

例子

可以查看 Showcase 来了解使用 docsify 的文档项目。

捐赠

如果你觉得 docsify 对你有帮助,或者想对我微小的工作一点资瓷,欢迎给我捐赠