A magical documentation site generator.
Gold Sponsor via Open Collective
- CDN: UNPKG | jsDelivr | cdnjs
- Awesome docsify
- Community chat
- 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
Look at this tutorial
These projects are using docsify to generate their sites. Pull requests welcome
Move to awesome-docsify
|docpress||Documentation website generator|
Online one-click setup for Contributing
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.
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 dev
Thank you to all our backers!
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].