mirror of https://github.com/IoTcat/docsify.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qingwei.li
e810ba38cb
|
6 years ago | |
---|---|---|
.github | 6 years ago | |
.vscode | 7 years ago | |
build | 6 years ago | |
docs | 6 years ago | |
lib | 6 years ago | |
packages/docsify-server-renderer | 6 years ago | |
src | 6 years ago | |
.eslintignore | 7 years ago | |
.eslintrc | 7 years ago | |
.gitignore | 7 years ago | |
.npmignore | 7 years ago | |
.travis.yml | 7 years ago | |
CHANGELOG.md | 6 years ago | |
CONTRIBUTING.md | 6 years ago | |
HISTORY.md | 7 years ago | |
LICENSE | 6 years ago | |
README.md | 6 years ago | |
app.js | 7 years ago | |
dev.html | 7 years ago | |
lerna.json | 7 years ago | |
package-lock.json | 6 years ago | |
package.json | 6 years ago |
README.md
A magical documentation site generator.
Glod Sponsor via Open Collective
Links
- Documentation
- CLI
- CDN: UNPKG | jsDelivr | cdnjs
- Awesome docsify
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)
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 | 📜 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
open http://localhost:3000
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
MIT