mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-12-04 04:59:46 +08:00
130 lines
6.3 KiB
Markdown
130 lines
6.3 KiB
Markdown
<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://github.com/docsifyjs/docsify/actions/workflows/test.yml"><img src="https://github.com/docsifyjs/docsify/actions/workflows/test.yml/badge.svg" alt="Build & Test"></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://discord.gg/3NwKFyR"><img alt="Join Discord community and chat about Docsify" src="https://img.shields.io/discord/713647066802421792.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&cacheSeconds=60"></a>
|
|
<a href="https://gitpod.io/#https://github.com/docsifyjs/docsify"><img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"></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
|
|
|
|
- [`develop` branch preview](https://docsifyjs.netlify.com/)
|
|
- [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://discord.gg/3NwKFyR)
|
|
|
|
## Features
|
|
|
|
- No statically built html files
|
|
- Simple and lightweight
|
|
- Smart full-text search plugin
|
|
- Multiple themes
|
|
- Useful plugin API
|
|
- Compatible with IE11
|
|
- Experimental SSR support ([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#showcase)
|
|
|
|
## Similar projects
|
|
|
|
| Project | Description |
|
|
| ------------------------------------------------ | ---------------------------------------- |
|
|
| [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right |
|
|
| [docpress](https://github.com/docpress/docpress) | Documentation website generator |
|
|
|
|
## Contributing
|
|
|
|
### 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.
|
|
- start `npm run dev`.
|
|
|
|
So that you can start straight away.
|
|
|
|
[](https://gitpod.io/#https://github.com/docsifyjs/docsify)
|
|
|
|
- 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
|
|
|
|
```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)
|
|
|
|
## Special Thanks
|
|
|
|
_Vercel_ has given us a Pro account.
|
|
|
|
<a href="https://vercel.com/?utm_source=docsifyjsdocs" target="_blank"><img src="docs/_media/vercel_logo.svg" width="100px"></a>
|