docsify/docs/README.md

29 lines
1007 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-03-25 15:52:21 +08:00
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](deploy.md).
2017-03-25 15:52:21 +08:00
See the [Quick start](quickstart.md) for more details.
2017-02-13 22:43:58 +08:00
## Features
2017-03-10 05:19:07 +08:00
* 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+
2017-05-31 22:19:43 +08:00
- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))
2017-02-13 22:43:58 +08:00
## Examples
Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to docsify in use.
2017-02-13 22:43:58 +08:00
## 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](https://github.com/QingWei-Li/donate). :heart: