mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
feb4b89461
* 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
28 lines
914 B
Markdown
28 lines
914 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. Instead, it smartly loads and parses your Markdown files and displays them as 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
|
|
|
|
- No statically built html files
|
|
- Simple and lightweight (~14kB gzipped)
|
|
- Smart full-text search plugin
|
|
- Multiple themes
|
|
- Useful plugin API
|
|
- Compatible with IE10+
|
|
|
|
## Examples
|
|
|
|
Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to 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:
|
|
|