docsify/docs
2018-07-05 16:50:21 +08:00
..
_images docs(en) finish 2017-02-13 22:43:58 +08:00
_media docs: add embed files, resolve #383, resolve #333, resolve #134 2018-02-11 22:22:06 +08:00
_coverpage.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
_navbar.md chore: add ru and es docs 2018-07-01 19:46:46 +08:00
_sidebar.md fix typo 2018-02-23 11:56:12 +08:00
.nojekyll Add logo (#28) 2016-12-18 15:30:50 +08:00
cdn.md Update cdn.md (#479) 2018-05-10 06:53:44 +08:00
CNAME add docsify.js.org 2016-11-28 12:22:47 +08:00
configuration.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
cover.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
custom-navbar.md docs: add mutiple covers 2018-02-11 22:22:06 +08:00
deploy.md docs: update netlify demo 2018-06-19 08:35:23 +08:00
embed-files.md chore: typo 2018-02-11 22:22:06 +08:00
helpers.md docs: update image resizing 2018-07-05 16:50:21 +08:00
index.html chore: add ru and es docs 2018-07-01 19:46:46 +08:00
language-highlight.md Update language-highlight.md (#277) 2017-10-13 02:46:32 -05:00
markdown.md chore(docs): fix markdown demo 2017-08-17 17:18:41 +08:00
more-pages.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
plugins.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
pwa.md update english docs 2017-03-09 22:19:07 +01:00
quickstart.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
README.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
ssr.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
themes.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
vue.md docs: fix a broken code block (#286) 2017-10-20 09:41:38 -05:00
write-a-plugin.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00

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 (~19kB 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. ❤️

Community

Users and development team are in the Gitter.