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.
110 lines
5.6 KiB
110 lines
5.6 KiB
<p align="center"> |
|
<a href="https://docsify.js.org"> |
|
<img alt="docsify" src="./docs/_media/icon.svg"> |
|
</a> |
|
</p> |
|
|
|
<p align="center"> |
|
A magical documentation site generator. |
|
</p> |
|
|
|
<p align="center"> |
|
<a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/docsify/backers/badge.svg?style=flat-square"></a> |
|
<a href="#sponsors"><img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a> |
|
<a href="https://travis-ci.org/docsifyjs/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/docsifyjs/docsify/master.svg?style=flat-square"></a> |
|
<a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a> |
|
<a href="https://github.com/QingWei-Li/donate"><img alt="donate" src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square"></a> |
|
<a href="https://gitter.im/docsifyjs/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img alt="gitter" src="https://img.shields.io/gitter/room/docsifyjs/docsify.svg?style=flat-square"></a> |
|
</p> |
|
|
|
<p align="center">Gold Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a></p> |
|
|
|
<p align="center"> |
|
<a href="https://opencollective.com/docsify/order/3254"> |
|
<img src="https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36"> |
|
</a> |
|
</p> |
|
|
|
## Links |
|
|
|
- [Documentation](https://docsify.js.org) |
|
- [CLI](https://github.com/docsifyjs/docsify-cli) |
|
- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify) |
|
- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify) |
|
- [Community chat](https://gitter.im/docsifyjs/Lobby) |
|
|
|
## Features |
|
|
|
- No statically built html files |
|
- Simple and lightweight (~21kB gzipped) |
|
- Smart full-text search plugin |
|
- Multiple themes |
|
- Useful plugin API |
|
- Compatible with IE10+ |
|
- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo)) |
|
- Support embedded files |
|
|
|
## Quick start |
|
|
|
Look at [this tutorial](https://docsify.js.org/#/quickstart) |
|
|
|
[](https://codesandbox.io/s/307qqv236) |
|
|
|
## Showcase |
|
|
|
These projects are using docsify to generate their sites. Pull requests welcome :blush: |
|
|
|
Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify) |
|
|
|
## Similar projects |
|
|
|
| Project | Description | |
|
| ------------------------------------------------ | ---------------------------------------- | |
|
| [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right | |
|
| [docpress](https://github.com/docpress/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 |
|
|
|
```bash |
|
npm run bootstrap && npm run dev |
|
``` |
|
|
|
## Backers |
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify#backers)] |
|
|
|
<a href="https://opencollective.com/docsify#backers" target="_blank"><img src="https://opencollective.com/docsify/backers.svg?width=890"></a> |
|
|
|
## Sponsors |
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/docsify#silver-sponsors)] |
|
|
|
<a href="https://opencollective.com/docsify/silver-sponsors/0/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/0/avatar.svg"></a> |
|
<a href="https://opencollective.com/docsify/silver-sponsors/1/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/1/avatar.svg"></a> |
|
<a href="https://opencollective.com/docsify/silver-sponsors/2/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/2/avatar.svg"></a> |
|
<a href="https://opencollective.com/docsify/silver-sponsors/3/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/3/avatar.svg"></a> |
|
<a href="https://opencollective.com/docsify/silver-sponsors/4/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/4/avatar.svg"></a> |
|
<a href="https://opencollective.com/docsify/silver-sponsors/5/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/5/avatar.svg"></a> |
|
<a href="https://opencollective.com/docsify/silver-sponsors/6/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/6/avatar.svg"></a> |
|
<a href="https://opencollective.com/docsify/silver-sponsors/7/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/7/avatar.svg"></a> |
|
<a href="https://opencollective.com/docsify/silver-sponsors/8/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/8/avatar.svg"></a> |
|
<a href="https://opencollective.com/docsify/silver-sponsors/9/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/9/avatar.svg"></a> |
|
|
|
## Contributors |
|
|
|
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. |
|
<a href="https://github.com/docsifyjs/docsify/graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a> |
|
|
|
## License |
|
|
|
[MIT](LICENSE) |
|
|
|
[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify?ref=badge_large)
|
|
|