mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-12-04 04:59:46 +08:00
28 lines
899 B
Markdown
28 lines
899 B
Markdown
## 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. It smartly loads and parses your Markdown files and displays them in website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](/deploy).
|
|
|
|
See the [Quick start](/quickstart) for more details.
|
|
|
|
## Features
|
|
|
|
- Not build static html files
|
|
- Simple and lightweight (~13kB gzipped)
|
|
- Smart full-text search plugin
|
|
- Multiple themes
|
|
- Useful plugin API
|
|
- Compatible with IE9+
|
|
|
|
## Examples
|
|
|
|
Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to see use the docsify generated website.
|
|
|
|
## Donate
|
|
|
|
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:
|
|
|