A magical documentation site generator.
Gold Sponsor via Open Collective
Links
develop
Branch preview- Documentation
- CLI
- CDN: UNPKG | jsDelivr | cdnjs
- Awesome Docsify
- Community Chat
Features
- 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
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
Online 1-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 repository.
- 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 add . && git commit -m '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!
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
Special Thanks
Vercel has given us a Pro account.