docsify/docs/zh-cn
2018-06-29 22:22:14 +08:00
..
_sidebar.md docs: update file size 2018-02-11 22:22:06 +08:00
cdn.md docs(cdn): update jsdelivr cdn 2017-06-01 10:29:12 +08:00
configuration.md feat: add logo option, #264 (#541) 2018-06-19 08:19:21 +08:00
cover.md docs: add mutiple covers 2018-02-11 22:22:06 +08:00
custom-navbar.md Update custom-navbar.md (#446) 2018-04-10 09:14:50 +09:00
deploy.md docs: update netlify demo 2018-06-19 08:35:23 +08:00
embed-files.md fix: resolve path of image and embed files, fixed #412 2018-03-06 11:57:48 +08:00
helpers.md feat: support image resizing, resolve #508 (#545) 2018-06-29 21:27:41 +08:00
language-highlight.md Fix broken footer (#178) 2017-06-01 13:32:39 +08:00
markdown.md Update url to markedjs (#410) 2018-03-04 07:35:01 +08:00
more-pages.md Update more-pages.md (#476) 2018-05-06 18:49:10 +08:00
plugins.md docs: update docs, fixed #526 2018-06-29 21:33:17 +08:00
pwa.md feat(emoji): add emoji plugin 2017-02-22 22:30:07 +08:00
quickstart.md docs: update quickstart 2018-01-03 09:56:15 +08:00
README.md docs: add gitter 2018-06-29 22:22:14 +08:00
ssr.md docs(ssr): update 2017-05-31 08:35:01 +08:00
themes.md docs: add docsify-themable 2018-06-19 15:29:28 +08: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

查看快速开始了解详情。

特性

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

例子

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

捐赠

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

Community

Users and development team are in the Gitter.