mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
29 lines
1.0 KiB
Markdown
29 lines
1.0 KiB
Markdown
# docsify
|
|
|
|
> A magical documentation site generator.
|
|
|
|
## What it is
|
|
|
|
Docsify turns your Markdown files into a documentation website instantly. Unlike most other documentation site generator tools, it doesn't need to build HTML files. Instead, it dynamically loads and parses your Markdown files and displays them as a website. To get started, create an `index.html` file and [deploy it on GitHub Pages](deploy.md) (for more details see the [Quick start](quickstart.md) guide).
|
|
|
|
## 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).
|