mirror of
https://github.com/wahyd4/docsify.git
synced 2026-08-09 05:16:06 +10:00
78290b21038a3ae09c4c7438bd89b14ca4c02805
Snyk has created this PR to upgrade docsify from 4.9.4 to 4.10.2. See this package in NPM: https://www.npmjs.com/package/docsify See this project in Snyk: https://app.snyk.io/org/anikethsaha/project/6efe7e04-4e52-497e-8ad5-570733cc577a?utm_source=github&utm_medium=upgrade-pr
A magical documentation site generator.
Gold Sponsor via Open Collective
Links
developbranch preview- Documentation
- CLI
- CDN: UNPKG | jsDelivr | cdnjs
- Awesome docsify
- Community chat
Features
- No statically built html files
- Simple and lightweight (~21kB gzipped)
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Compatible with IE11
- Support SSR (example)
- Support embedded files
Quick start
Look at this tutorial
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
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]
Contributors
This project exists thanks to all the people who contribute. [Contribute].
License
Languages
JavaScript
82.4%
Stylus
13.4%
HTML
3.7%
Shell
0.5%