docsify

A magical documentation site generator.

What it is

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 a website. To start using it, all you need to do is create an index.html and deploy it on GitHub Pages.

See the Quick start guide for more details.

Features

  • No statically built html files
  • Simple and lightweight (~21kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Emoji support
  • Compatible with IE11
  • Support server-side rendering (example)

Examples

Check out the Showcase to see docsify in use.

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. heart

Community

Users and the development team are usually in the Gitter chat room.