mirror of
https://github.com/docsifyjs/docsify.git
synced 2026-01-18 15:13:00 +00:00
00a87311b0
This aligns it with what the docs were already saying erroneously, plus this is useful in cases when people have refs to an element already (embedding Docsify in a custom element shadow root, or in a React component that has a ref to the target element, etc).
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
- Compatible with IE11
- Support server-side rendering (example)
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.
Special Thanks
Vercel has given us a Pro account.
