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"><img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a>
|
14 | <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>
|
15 | <a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
|
16 | <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>
|
17 | <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>
|
18 | </p>
|
19 |
|
20 | <p align="center">Gold Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a></p>
|
21 |
|
22 | <p align="center">
|
23 | <a href="https://opencollective.com/docsify/order/3254">
|
24 | <img src="https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36">
|
25 | </a>
|
26 | </p>
|
27 |
|
28 | ## Links
|
29 |
|
30 | - [`develop` branch preview](https://docsifyjs.netlify.com/)
|
31 | - [Documentation](https://docsify.js.org)
|
32 | - [CLI](https://github.com/docsifyjs/docsify-cli)
|
33 | - CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
|
34 | - [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
|
35 | - [Community chat](https://gitter.im/docsifyjs/Lobby)
|
36 |
|
37 | ## Features
|
38 |
|
39 | - No statically built html files
|
40 | - Simple and lightweight (~21kB gzipped)
|
41 | - Smart full-text search plugin
|
42 | - Multiple themes
|
43 | - Useful plugin API
|
44 | - Compatible with IE11
|
45 | - Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
|
46 | - Support embedded files
|
47 |
|
48 | ## Quick start
|
49 |
|
50 | Look at [this tutorial](https://docsify.js.org/#/quickstart)
|
51 |
|
52 | [![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)
|
53 |
|
54 | ## Showcase
|
55 |
|
56 | These projects are using docsify to generate their sites. Pull requests welcome :blush:
|
57 |
|
58 | Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase)
|
59 |
|
60 | ## Similar projects
|
61 |
|
62 | | Project | Description |
|
63 | | ------------------------------------------------ | ---------------------------------------- |
|
64 | | [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right |
|
65 | | [docpress](https://github.com/docpress/docpress) | Documentation website generator |
|
66 |
|
67 | ## Contributing
|
68 |
|
69 | - Fork it!
|
70 | - Create your feature branch: `git checkout -b my-new-feature`
|
71 | - Commit your changes: `git commit -am 'Add some feature'`
|
72 | - Push to the branch: `git push origin my-new-feature`
|
73 | - Submit a pull request
|
74 |
|
75 | ## Development
|
76 |
|
77 | ```bash
|
78 | npm run bootstrap && npm run dev
|
79 | ```
|
80 |
|
81 | ## Backers
|
82 |
|
83 | Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify#backers)]
|
84 |
|
85 | <a href="https://opencollective.com/docsify#backers" target="_blank"><img src="https://opencollective.com/docsify/backers.svg?width=890"></a>
|
86 |
|
87 | ## Sponsors
|
88 |
|
89 | 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)]
|
90 |
|
91 | <a href="https://opencollective.com/docsify/silver-sponsors/0/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/0/avatar.svg"></a>
|
92 | <a href="https://opencollective.com/docsify/silver-sponsors/1/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/1/avatar.svg"></a>
|
93 | <a href="https://opencollective.com/docsify/silver-sponsors/2/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/2/avatar.svg"></a>
|
94 | <a href="https://opencollective.com/docsify/silver-sponsors/3/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/3/avatar.svg"></a>
|
95 | <a href="https://opencollective.com/docsify/silver-sponsors/4/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/4/avatar.svg"></a>
|
96 | <a href="https://opencollective.com/docsify/silver-sponsors/5/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/5/avatar.svg"></a>
|
97 | <a href="https://opencollective.com/docsify/silver-sponsors/6/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/6/avatar.svg"></a>
|
98 | <a href="https://opencollective.com/docsify/silver-sponsors/7/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/7/avatar.svg"></a>
|
99 | <a href="https://opencollective.com/docsify/silver-sponsors/8/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/8/avatar.svg"></a>
|
100 | <a href="https://opencollective.com/docsify/silver-sponsors/9/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/9/avatar.svg"></a>
|
101 |
|
102 | ## Contributors
|
103 |
|
104 | This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
105 | <a href="https://github.com/docsifyjs/docsify/graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>
|
106 |
|
107 | ## License
|
108 |
|
109 | [MIT](LICENSE)
|
110 |
|
111 | [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify?ref=badge_large)
|