mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-11-29 18:48:14 +08:00
87 lines
3.8 KiB
Markdown
87 lines
3.8 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://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=48">
|
|
</a>
|
|
</p>
|
|
|
|
Docsify turns one or more Markdown files into a Website, with no build process required.
|
|
|
|
## Features
|
|
|
|
- No statically built html files
|
|
- Simple and lightweight
|
|
- Smart full-text search plugin
|
|
- Multiple themes
|
|
- Useful plugin API
|
|
- Emoji support
|
|
|
|
## Quick Start
|
|
|
|
Get going fast by using a static web server or GitHub Pages with this ready-to-use [Docsify Template](https://github.com/docsifyjs/docsify-template), review the [quick start tutorial](https://docsify.js.org/#/quickstart) or jump right into a CodeSandbox example site with the button below.
|
|
|
|
[](https://codesandbox.io/s/307qqv236)
|
|
|
|
## Showcase
|
|
|
|
A large collection of showcase projects are included in [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase).
|
|
|
|
## Links
|
|
|
|
- [Documentation](https://docsify.js.org)
|
|
- [Docsify CLI (Command Line Interface)](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)
|
|
- [`develop` branch preview](https://docsify-preview.vercel.app/)
|
|
- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
|
|
- [Community chat](https://discord.gg/3NwKFyR)
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
|
|
## Backers
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify/contribute)]
|
|
|
|
<a href="https://opencollective.com/docsify#backers" target="_blank"><img src="https://opencollective.com/docsify/backers.svg?width=890"></a>
|
|
|
|
## Sponsors
|
|
|
|
Thank you for supporting this project! ❤️ [[Become a sponsor](https://opencollective.com/docsify/contribute)]
|
|
|
|
<img src="https://opencollective.com/docsify/sponsors.svg?width=890" />
|
|
|
|
## 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
|
|
|
|
A preview of Docsify's PR and develop branch is <a href="https://vercel.com/?utm_source=docsifyjs&utm_campaign=oss" target="_blank">Powered by <img src="https://cdn.jsdelivr.net/gh/docsifyjs/docsify/docs/_media/vercel_logo.svg" alt="Vercel" width="133px"></a>
|