docsify/docs/zh-cn
2017-10-12 00:36:23 +08:00
..
_sidebar.md docs(changelog): 4.1.0 2017-05-30 12:05:25 +08:00
cdn.md docs(cdn): update jsdelivr cdn 2017-06-01 10:29:12 +08:00
configuration.md feat: ignore to compiled link, fixed #203 (#204) 2017-07-10 22:38:26 +08:00
cover.md feat(route): auto remove .md extension 2017-03-25 15:52:21 +08:00
custom-navbar.md feat(route): auto remove .md extension 2017-03-25 15:52:21 +08:00
deploy.md chore: update docs 2017-10-12 00:36:23 +08:00
helpers.md feat(compiler): support for setting target attribute for link, fixed #230 2017-08-10 08:45:49 +08:00
language-highlight.md Fix broken footer (#178) 2017-06-01 13:32:39 +08:00
markdown.md chore(docs): fix markdown demo 2017-08-17 17:18:41 +08:00
more-pages.md feat(route): auto remove .md extension 2017-03-25 15:52:21 +08:00
plugins.md chore: add doc for codesponsor 2017-09-20 09:01:06 +08:00
pwa.md feat(emoji): add emoji plugin 2017-02-22 22:30:07 +08:00
quickstart.md chore: update docs 2017-10-12 00:36:23 +08:00
README.md update package size 2017-06-02 22:37:27 +08:00
ssr.md docs(ssr): update 2017-05-31 08:35:01 +08:00
themes.md add German docs 2017-03-11 22:13:25 +01:00
vue.md docs(vue): fix typo 2017-03-11 18:27:43 +08:00
write-a-plugin.md docs(write-a-plugin): update demo 2017-05-31 08:39:01 +08:00

docsify

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

是什么

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

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

查看快速开始了解详情。

特性

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

例子

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

捐赠

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