docsify/docs/README.md
2017-02-19 14:38:38 +08:00

900 B

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 (~14kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE10+

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. ❤️