test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-02 20:20:30 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
8463f4d5c5
docsify/docs
History
qingwei.li 9e7d365872 bump: 3.3.0
2017-03-07 12:00:23 +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 switch to doneEach and cache #main dom 2017-03-07 11:30:09 +08:00
_coverpage.md bump: 3.3.0 2017-03-07 12:00:23 +08:00
_sidebar.md docs: fix typo, fixed #114 2017-03-05 10:26:59 +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 switch to doneEach and cache #main dom 2017-03-07 11:30:09 +08:00
cover.md docs: update package size 2017-02-24 20:18:17 +08:00
custom-navbar.md docs: fix typo, fixed #114 2017-03-05 10:26:59 +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: tweaks 2017-02-22 22:11:05 +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 Update dictory structure in more-pages.md (#113) 2017-03-04 14:53:22 +08:00
plugins.md add external-script plugin 2017-03-06 23:57:28 +08:00
pwa.md docs(sw): cache unpkg.com 2017-02-22 09:39:17 +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
sw.js docs(sw): cache unpkg.com 2017-02-22 09:39:17 +08:00
themes.md docs: add executeScript demo 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

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. Instead, it smartly loads and parses your Markdown files and displays them as 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

  • No statically built html files
  • Simple and lightweight (~16kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Emoji support
  • Compatible with IE10+

Examples

Check out the Showcase to docsify in use.

Donate

Please consider donating 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. ❤️