Fetching latest commit…
A magical documentation site generator.
Glod Sponsor via Open Collective
Links
Features
- No statically built html files
- Simple and lightweight (~19kB gzipped)
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Compatible with IE10+
- Support SSR (example)
- Support embedded files
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 | |
| 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 devBackers
Thank you to all our backers!
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
MIT