mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-11-29 18:48:14 +08:00
b621e0e4e7
BREAKING: In a minority of cases syntax updates may break apps running in very old browsers (such as Internet Explorer), or apps that build Docsify in a custom way with old build tools. To upgrade, build Docsify for older browsers in a custom way, or update existing build tools to handle newer syntax. DEPRECATED: `$docsify.themeColor` is deprecated and will be eventually removed, use a `--theme-color` CSS variable in your style sheet. |
||
|---|---|---|
| .. | ||
| _images | ||
| _media | ||
| _coverpage.md | ||
| _navbar.md | ||
| _sidebar.md | ||
| .nojekyll | ||
| cdn.md | ||
| CNAME | ||
| configuration.md | ||
| cover.md | ||
| custom-navbar.md | ||
| deploy.md | ||
| embed-files.md | ||
| emoji.md | ||
| helpers.md | ||
| index.html | ||
| language-highlight.md | ||
| markdown.md | ||
| more-pages.md | ||
| plugins.md | ||
| pwa.md | ||
| quickstart.md | ||
| README.md | ||
| themes.md | ||
| vue.md | ||
| write-a-plugin.md | ||
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.
See the Quick start 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 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. ❤️
Community
Users and the development team are usually in the Discord server.