mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-11-30 02:58:37 +08:00
4.9 KiB
4.9 KiB
A magical documentation site generator.
Glod Sponsor via Open Collective
Links
- Documentation
- CLI
- CDN: UNPKG | jsDelivr | cdnjs
- Awesome docsify
Features
- No statically built html files
- Simple and lightweight (~18kB gzipped)
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Compatible with IE10+
- Support SSR (example)
Quick start
Look at this tutorial or online demo.
Showcase
These projects are using docsify to generate their sites. Pull requests welcome 😊
Move to awesome-docsify
Similar projects
| Project | Description |
|---|---|
| docute | 📜 Effortlessly documentation done right |
| docpress | Documentation website generator |
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
Development
npm run bootstrap && npm run dev
open http://localhost:3000
Backers
Thank you to all our backers! 🙏 [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
License
MIT
