mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
41fd8f624e
* chore: Remove Gold sponsors section Because they don't sponsor us anymore. * chore: Remove route4me logo --------- Co-authored-by: Koy Zhuang <koy@ko8e24.top>
31 lines
1.0 KiB
Markdown
31 lines
1.0 KiB
Markdown
# 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
|
|
|
|
## 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 [Discord server](https://discord.gg/3NwKFyR).
|