test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-03 04:31:20 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
dc536a3930
docsify/docs
History
qingwei.li d62da2034f bump: 2.4.1
2017-02-13 23:23:13 +08:00
..
_images docs(en) finish 2017-02-13 22:43:58 +08:00
_media doc(zh-cn): update all documents 2017-02-12 15:51:26 +08:00
zh-cn feat(hook): add doneEach 2017-02-13 23:06:30 +08:00
_coverpage.md bump: 2.4.1 2017-02-13 23:23:13 +08:00
_sidebar.md docs(en) finish 2017-02-13 22:43:58 +08:00
.nojekyll Add logo (#28) 2016-12-18 15:30:50 +08:00
cdn.md docs(en) finish 2017-02-13 22:43:58 +08:00
CNAME add docsify.js.org 2016-11-28 12:22:47 +08:00
configuration.md docs(en) finish 2017-02-13 22:43:58 +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
index.html docs(zh-cn): finish chinese documents 2017-02-12 20:12:36 +08:00
language-highlight.md docs(en) finish 2017-02-13 22:43:58 +08:00
markdown.md docs(en) finish 2017-02-13 22:43:58 +08:00
more-pages.md docs(en) finish 2017-02-13 22:43:58 +08:00
plugins.md feat(hook): add doneEach 2017-02-13 23:06:30 +08:00
quickstart.md docs(en) finish 2017-02-13 22:43:58 +08:00
README.md docs(en) finish 2017-02-13 22:43:58 +08:00
themes.md docs(en) finish 2017-02-13 22:43:58 +08:00
vue.md docs(en) finish 2017-02-13 22:43:58 +08:00

README.md

docsify

A magical documentation site generator.

What is it

docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. It smartly loads and parses your Markdown files and displays them in website. All you need to do is create an index.html to start and deploy it on GitHub Pages.

See the Quick start for more details.

Features

  • Not build static html files
  • Simple and lightweight (~13kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE9+

Examples

Check out the Showcase to see use the docsify generated website.

Donate

If you think docsify is helpful to you or that my work is valuable. I am happy if you can help me buy a cup of coffee. ❤️