A magical documentation site generator.
Gold Sponsor via Open Collective
developbranch preview- Documentation
- CLI
- CDN: UNPKG | jsDelivr | cdnjs
- Awesome docsify
- Community chat
- No statically built html files
- Simple and lightweight
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Compatible with IE11
- Support SSR (example)
- Support embedded files
Look at this tutorial
These projects are using docsify to generate their sites. Pull requests welcome 馃槉
Move to awesome-docsify
| Project | Description |
|---|---|
| docute | 馃摐 Effortlessly documentation done right |
| docpress | Documentation website generator |
You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically:
- clone the docsify repo.
- install the dependencies.
- start
npm run dev.
So that you can start straight away.
- 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
npm run bootstrap && npm run devThank you to all our backers! 馃檹 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
This project exists thanks to all the people who contribute. [Contribute].
