docsify/docs/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. ❤️