iSharkFly-Docs
/
docsify-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
docsify 中文文档
1 Commit 2 Branches 0 Tags 419 KiB
Dockerfile 100%
Go to file
qingwei.li 9cb6c2d1e7 first commit 2018-07-01 19:27:01 +08:00
README.md first commit 2018-07-01 19:27:01 +08:00
_sidebar.md first commit 2018-07-01 19:27:01 +08:00
cdn.md first commit 2018-07-01 19:27:01 +08:00
configuration.md first commit 2018-07-01 19:27:01 +08:00
cover.md first commit 2018-07-01 19:27:01 +08:00
custom-navbar.md first commit 2018-07-01 19:27:01 +08:00
deploy.md first commit 2018-07-01 19:27:01 +08:00
embed-files.md first commit 2018-07-01 19:27:01 +08:00
helpers.md first commit 2018-07-01 19:27:01 +08:00
language-highlight.md first commit 2018-07-01 19:27:01 +08:00
markdown.md first commit 2018-07-01 19:27:01 +08:00
more-pages.md first commit 2018-07-01 19:27:01 +08:00
plugins.md first commit 2018-07-01 19:27:01 +08:00
pwa.md first commit 2018-07-01 19:27:01 +08:00
quickstart.md first commit 2018-07-01 19:27:01 +08:00
ssr.md first commit 2018-07-01 19:27:01 +08:00
themes.md first commit 2018-07-01 19:27:01 +08:00
vue.md first commit 2018-07-01 19:27:01 +08:00
write-a-plugin.md first commit 2018-07-01 19:27:01 +08:00

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.