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](deploy.md).

See the [Quick start](quickstart.md) for more details.

## Features

* No statically built html files
* Simple and lightweight (~18kB gzipped)
* Smart full-text search plugin
* Multiple themes
* Useful plugin API
* Emoji support
* Compatible with IE10+
- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))

## Examples

Check out the [Showcase](https://github.com/QingWei-Li/docsify/#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](https://github.com/QingWei-Li/donate). :heart:
docs(en) finish 2017-02-13 22:43:58 +08:00			`## docsify`
1.3 (#38) * Add cover page * Update doc * Add kbd style, resolve #37 * headling can cliked, resolve #36 * Update change log, close #35 * Update docs 2016-12-22 00:24:54 +08:00
			`> A magical documentation site generator.`

docs(en) finish 2017-02-13 22:43:58 +08:00			`## What is it`
Update docs 2017-01-04 21:41:35 +08:00
feat(route): auto remove .md extension 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).
customize sidebar and navbar via markdown file, #6 (#8) * Refactor: use iife * Feat: customize sidebar and navbar via markdown file, #6 * Add changelog 2016-11-29 01:07:47 +08:00
feat(route): auto remove .md extension 2017-03-25 15:52:21 +08:00			`See the [Quick start](quickstart.md) for more details.`
customize sidebar and navbar via markdown file, #6 (#8) * Refactor: use iife * Feat: customize sidebar and navbar via markdown file, #6 * Add changelog 2016-11-29 01:07:47 +08:00
docs(en) finish 2017-02-13 22:43:58 +08:00			`## Features`
customize sidebar and navbar via markdown file, #6 (#8) * Refactor: use iife * Feat: customize sidebar and navbar via markdown file, #6 * Add changelog 2016-11-29 01:07:47 +08:00
update english docs 2017-03-10 05:19:07 +08:00			`* No statically built html files`
update package size 2017-06-02 22:37:27 +08:00			`* Simple and lightweight (~18kB gzipped)`
update english docs 2017-03-10 05:19:07 +08:00			`* Smart full-text search plugin`
			`* Multiple themes`
			`* Useful plugin API`
			`* Emoji support`
			`* Compatible with IE10+`
docs: add feature 2017-05-31 22:19:43 +08:00			`- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))`
feat(plugins): add Google Analytics plugin (#66) 2017-02-09 22:16:15 +08:00
docs(en) finish 2017-02-13 22:43:58 +08:00			`## Examples`
feat(plugins): add Google Analytics plugin (#66) 2017-02-09 22:16:15 +08:00
Update docs: Getting started (#85) * fixed look of links in blockquote * updated main README * updated getting started * updated more-pages * make custom sidebar loading clear * updated custom navbar * added markdown comments * updated cover documentation * updated cover page * updated sidebar 2017-02-21 14:04:16 +08:00			`Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to docsify in use.`
feat(plugins): add Google Analytics plugin (#66) 2017-02-09 22:16:15 +08:00
docs(en) finish 2017-02-13 22:43:58 +08:00			`## Donate`
feat(plugins): add Google Analytics plugin (#66) 2017-02-09 22:16:15 +08:00
Update docs: Getting started (#85) * fixed look of links in blockquote * updated main README * updated getting started * updated more-pages * make custom sidebar loading clear * updated custom navbar * added markdown comments * updated cover documentation * updated cover page * updated sidebar 2017-02-21 14:04:16 +08:00			`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:`