73a38c3878
* updated german links * fixed links where `QingWei-Li` should've been `docsifyjs` * naturally excluded donate links and links to private projects like `vuep` unrelated to docsify --- See commit for details. If you have a question, just ask. |
||
|---|---|---|
| .. | ||
| _images | ||
| _media | ||
| de-de | ||
| zh-cn | ||
| .nojekyll | ||
| _coverpage.md | ||
| _navbar.md | ||
| _sidebar.md | ||
| cdn.md | ||
| CNAME | ||
| configuration.md | ||
| cover.md | ||
| custom-navbar.md | ||
| deploy.md | ||
| embed-files.md | ||
| helpers.md | ||
| index.html | ||
| language-highlight.md | ||
| markdown.md | ||
| more-pages.md | ||
| plugins.md | ||
| pwa.md | ||
| quickstart.md | ||
| README.md | ||
| ssr.md | ||
| themes.md | ||
| vue.md | ||
| write-a-plugin.md | ||
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.
See the Quick start for more details.
Features
- No statically built html files
- Simple and lightweight (~19kB gzipped)
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Emoji support
- Compatible with IE10+
- Support SSR (example)
Examples
Check out the 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. ❤️
Community
Users and development team are in the Gitter.