docsify/docs/README.md

28 lines
900 B
Markdown
Raw Normal View History

2017-02-13 22:43:58 +08:00
## docsify
> A magical documentation site generator.
2017-02-13 22:43:58 +08:00
## What is it
2017-01-04 21:41:35 +08:00
2017-02-13 22:43:58 +08:00
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](/deploy).
2017-02-13 22:43:58 +08:00
See the [Quick start](/quickstart) for more details.
2017-02-13 22:43:58 +08:00
## Features
2017-02-13 22:43:58 +08:00
- Not build static html files
2017-02-15 20:00:56 +08:00
- Simple and lightweight (~14kB gzipped)
2017-02-13 22:43:58 +08:00
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
2017-02-17 23:09:09 +08:00
- Compatible with IE10+
2017-02-13 22:43:58 +08:00
## Examples
2017-02-13 22:43:58 +08:00
Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to see use the docsify generated website.
2017-02-13 22:43:58 +08:00
## Donate
2017-02-13 22:43:58 +08:00
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](https://github.com/QingWei-Li/donate). :heart: