1 | <p align="center">
|
2 | <a href="https://docsify.js.org">
|
3 | <img alt="docsify" src="./docs/_media/icon.svg">
|
4 | </a>
|
5 | </p>
|
6 |
|
7 | <p align="center">
|
8 | A magical documentation site generator.
|
9 | </p>
|
10 |
|
11 | <p align="center">
|
12 | <a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/docsify/backers/badge.svg?style=flat-square"></a>
|
13 | <a href="#sponsors">
|
14 | <img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a>
|
15 | <a><img src="https://github.com/docsifyjs/docsify/workflows/Unit%20tests%20Suite/badge.svg?branch=develop&event=push" alt="Unit tests Suite"></a>
|
16 | <a><img src="https://github.com/docsifyjs/docsify/workflows/Linting%20Checks/badge.svg?branch=develop&event=push" alt="Linting Checks"></a>
|
17 | <a><img src="https://github.com/docsifyjs/docsify/workflows/Testing%20the%20e2e%20test%20suites/badge.svg?branch=develop&event=push" alt="Testing the e2e test suites"></a>
|
18 | <a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
|
19 | <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>
|
20 | <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>
|
21 | <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>
|
22 | </p>
|
23 |
|
24 | <p align="center">Gold Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a></p>
|
25 |
|
26 | <p align="center">
|
27 | <a href="https://opencollective.com/docsify/order/3254">
|
28 | <img src="https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36">
|
29 | </a>
|
30 | </p>
|
31 |
|
32 | ## Links
|
33 |
|
34 | - [`develop` branch preview](https://docsifyjs.netlify.com/)
|
35 | - [Documentation](https://docsify.js.org)
|
36 | - [CLI](https://github.com/docsifyjs/docsify-cli)
|
37 | - CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
|
38 | - [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
|
39 | - [Community chat](https://discord.gg/3NwKFyR)
|
40 |
|
41 | ## Features
|
42 |
|
43 | - No statically built html files
|
44 | - Simple and lightweight
|
45 | - Smart full-text search plugin
|
46 | - Multiple themes
|
47 | - Useful plugin API
|
48 | - Compatible with IE11
|
49 | - Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
|
50 | - Support embedded files
|
51 |
|
52 | ## Quick start
|
53 |
|
54 | Look at [this tutorial](https://docsify.js.org/#/quickstart)
|
55 |
|
56 | [![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)
|
57 |
|
58 | ## Showcase
|
59 |
|
60 | These projects are using docsify to generate their sites. Pull requests welcome :blush:
|
61 |
|
62 | Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase)
|
63 |
|
64 | ## Similar projects
|
65 |
|
66 | | Project | Description |
|
67 | | ------------------------------------------------ | ---------------------------------------- |
|
68 | | [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right |
|
69 | | [docpress](https://github.com/docpress/docpress) | Documentation website generator |
|
70 |
|
71 | ## Contributing
|
72 |
|
73 | ### Online one-click setup for Contributing
|
74 |
|
75 | You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically:
|
76 |
|
77 | - clone the docsify repo.
|
78 | - install the dependencies.
|
79 | - start `npm run dev`.
|
80 |
|
81 | So that you can start straight away.
|
82 |
|
83 | [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify)
|
84 |
|
85 | - Fork it!
|
86 | - Create your feature branch: `git checkout -b my-new-feature`
|
87 | - Commit your changes: `git add . && git commit -m 'Add some feature'`
|
88 | - Push to the branch: `git push origin my-new-feature`
|
89 | - Submit a pull request
|
90 |
|
91 | ## Development
|
92 |
|
93 | ```bash
|
94 | npm run bootstrap && npm run dev
|
95 | ```
|
96 |
|
97 | ## Backers
|
98 |
|
99 | Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify#backers)]
|
100 |
|
101 | <a href="https://opencollective.com/docsify#backers" target="_blank"><img src="https://opencollective.com/docsify/backers.svg?width=890"></a>
|
102 |
|
103 | ## Sponsors
|
104 |
|
105 | 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)]
|
106 |
|
107 | <a href="https://opencollective.com/docsify/silver-sponsors/0/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/0/avatar.svg"></a>
|
108 | <a href="https://opencollective.com/docsify/silver-sponsors/1/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/1/avatar.svg"></a>
|
109 | <a href="https://opencollective.com/docsify/silver-sponsors/2/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/2/avatar.svg"></a>
|
110 | <a href="https://opencollective.com/docsify/silver-sponsors/3/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/3/avatar.svg"></a>
|
111 | <a href="https://opencollective.com/docsify/silver-sponsors/4/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/4/avatar.svg"></a>
|
112 | <a href="https://opencollective.com/docsify/silver-sponsors/5/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/5/avatar.svg"></a>
|
113 | <a href="https://opencollective.com/docsify/silver-sponsors/6/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/6/avatar.svg"></a>
|
114 | <a href="https://opencollective.com/docsify/silver-sponsors/7/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/7/avatar.svg"></a>
|
115 | <a href="https://opencollective.com/docsify/silver-sponsors/8/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/8/avatar.svg"></a>
|
116 | <a href="https://opencollective.com/docsify/silver-sponsors/9/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/9/avatar.svg"></a>
|
117 |
|
118 | ## Contributors
|
119 |
|
120 | This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
121 | <a href="https://github.com/docsifyjs/docsify/graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>
|
122 |
|
123 | ## License
|
124 |
|
125 | [MIT](LICENSE)
|
126 |
|
127 | ## Special Thanks
|
128 |
|
129 | _Vercel_ has given us a Pro account.
|
130 |
|
131 | <a href="https://vercel.com/?utm_source=docsifyjsdocs" target="_blank"><img src="docs/_media/vercel_logo.svg" width="100px"></a>
|