docsify/docs/README.md

## docsify

> A magical documentation site generator.

## What it is

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 a website. To start using it, all you need to do is create an `index.html` and [deploy it on GitHub Pages](deploy.md).

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

## Features

- No statically built html files
- Simple and lightweight
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Emoji support
- Compatible with IE11
- Support server-side rendering ([example](https://github.com/docsifyjs/docsify-ssr-demo))

## Examples

Check out the [Showcase](https://github.com/docsifyjs/awesome-docsify#showcase) to see 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:

## Community

Users and the development team are usually in the [Gitter chat room](https://gitter.im/docsifyjs/Lobby).

## Special Thanks

_Vercel_ has given us a Pro account.

<a href="https://vercel.com/?utm_source=docsifyjsdocs" target="_blank"><img src="_media/vercel_logo.svg" width="100px"></a>
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.`

chore: README: various small tweaks (#651) - Change "What is it" heading to "What it is", as it's not a question - Expand SSR acronym - Slightly reword some passages for clarity 2018-10-23 15:01:55 +08:00			`## What it is`
Update docs 2017-01-04 21:41:35 +08:00
chore: README: various small tweaks (#651) - Change "What is it" heading to "What it is", as it's not a question - Expand SSR acronym - Slightly reword some passages for clarity 2018-10-23 15:01:55 +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 a website. To start using it, all you need to do is create an `index.html` 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
chore: README: various small tweaks (#651) - Change "What is it" heading to "What it is", as it's not a question - Expand SSR acronym - Slightly reword some passages for clarity 2018-10-23 15:01:55 +08:00			`See the [Quick start](quickstart.md) guide 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
docs: add gitter 2018-06-29 22:22:14 +08:00			`- No statically built html files`
docs: remove bundle size from the home page and documentation (#1257) Co-authored-by: 沈唁 <52o@qq52o.cn> 2020-07-02 23:32:47 +08:00			`- Simple and lightweight`
docs: add gitter 2018-06-29 22:22:14 +08:00			`- Smart full-text search plugin`
			`- Multiple themes`
			`- Useful plugin API`
			`- Emoji support`
Align IE support from root README.md 2019-04-14 17:27:03 +08:00			`- Compatible with IE11`
chore: README: various small tweaks (#651) - Change "What is it" heading to "What it is", as it's not a question - Expand SSR acronym - Slightly reword some passages for clarity 2018-10-23 15:01:55 +08:00			`- Support server-side rendering ([example](https://github.com/docsifyjs/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
Readme: Improve outdated links to showcase Link to Showcase in awesome-docsify. 2019-04-26 11:25:17 +08:00			`Check out the [Showcase](https://github.com/docsifyjs/awesome-docsify#showcase) to see 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:`
docs: add gitter 2018-06-29 22:22:14 +08:00
			`## Community`

chore: README: various small tweaks (#651) - Change "What is it" heading to "What it is", as it's not a question - Expand SSR acronym - Slightly reword some passages for clarity 2018-10-23 15:01:55 +08:00			`Users and the development team are usually in the [Gitter chat room](https://gitter.im/docsifyjs/Lobby).`
docs: add vercel logo (#1267) * docs: add vercel logo * update vercel svg to file Co-authored-by: sy-records <52o@qq52o.cn> 2020-07-04 18:32:16 +08:00
			`## Special Thanks`

			`_Vercel_ has given us a Pro account.`

			`<a href="https://vercel.com/?utm_source=docsifyjsdocs" target="_blank"><img src="_media/vercel_logo.svg" width="100px"></a>`