docsify/docs/README.md

31 lines
1.0 KiB
Markdown
Raw Normal View History

2017-02-13 22:43:58 +08:00
## docsify
> A magical documentation site generator.
## What it is
2017-01-04 21:41:35 +08:00
2022-02-02 17:50:20 +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).
See the [Quick start](quickstart.md) guide for more details.
2017-02-13 22:43:58 +08:00
## Features
2018-06-29 22:22:14 +08:00
- No statically built html files
- Simple and lightweight
2018-06-29 22:22:14 +08:00
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Emoji support
2017-02-13 22:43:58 +08:00
## Examples
Check out the [Showcase](https://github.com/docsifyjs/awesome-docsify#showcase) to see 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:
2018-06-29 22:22:14 +08:00
## Community
Users and the development team are usually in the [Discord server](https://discord.gg/3NwKFyR).