2016-12-18 15:30:50 +08:00
< p align = "center" >
< a href = "https://docsify.js.org" >
2017-11-30 16:04:11 +08:00
< img alt = "docsify" src = "./docs/_media/icon.svg" >
2016-12-18 15:30:50 +08:00
< / a >
< / p >
< p align = "center" >
A magical documentation site generator.
< / p >
< p align = "center" >
2018-02-11 15:04:31 +08:00
< 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 >
2018-07-01 13:48:44 +08:00
< 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 >
2016-12-18 19:43:58 +08:00
< a href = "https://www.npmjs.com/package/docsify" > < img alt = "npm" src = "https://img.shields.io/npm/v/docsify.svg?style=flat-square" > < / a >
2017-02-12 16:30:45 +08:00
< 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 >
2018-06-29 22:22:14 +08:00
< 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 >
2016-12-18 15:30:50 +08:00
< / p >
2016-11-20 15:56:37 +08:00
2018-10-18 22:56:00 +08:00
< p align = "center" > Gold Sponsor via < a href = "https://opencollective.com/docsify" > Open Collective< / a > < / p >
2018-02-11 15:04:31 +08:00
2018-01-23 23:52:12 +08:00
< p align = "center" >
2018-10-18 22:56:00 +08:00
< a href = "https://opencollective.com/docsify/order/3254" >
2018-02-11 15:04:31 +08:00
< img src = "https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36" >
< / a >
2018-01-23 23:52:12 +08:00
< / p >
2017-09-11 14:30:48 +08:00
2016-11-26 18:08:00 +08:00
## Links
2017-03-10 05:19:57 +08:00
2019-04-21 17:58:07 +08:00
- [`develop` branch preview ](https://docsifyjs.netlify.com/ )
2018-06-29 22:22:14 +08:00
- [Documentation ](https://docsify.js.org )
2018-07-01 13:48:44 +08:00
- [CLI ](https://github.com/docsifyjs/docsify-cli )
2018-06-29 22:22:14 +08:00
- CDN: [UNPKG ](https://unpkg.com/docsify/ ) | [jsDelivr ](https://cdn.jsdelivr.net/npm/docsify/ ) | [cdnjs ](https://cdnjs.com/libraries/docsify )
2018-07-01 13:48:44 +08:00
- [Awesome docsify ](https://github.com/docsifyjs/awesome-docsify )
2018-06-29 22:22:14 +08:00
- [Community chat ](https://gitter.im/docsifyjs/Lobby )
2016-11-26 14:09:06 +08:00
2016-11-20 15:56:37 +08:00
## Features
2017-02-21 14:04:16 +08:00
2018-06-29 22:22:14 +08:00
- No statically built html files
2018-10-31 22:17:55 +08:00
- Simple and lightweight (~21kB gzipped)
2018-06-29 22:22:14 +08:00
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
2019-02-26 15:27:59 +08:00
- Compatible with IE11
2018-07-01 13:48:44 +08:00
- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
2018-06-29 22:22:14 +08:00
- Support embedded files
2016-11-20 15:56:37 +08:00
## Quick start
2017-03-10 05:19:57 +08:00
2018-11-01 17:59:03 +08:00
Look at [this tutorial ](https://docsify.js.org/#/quickstart )
[](https://codesandbox.io/s/307qqv236)
2016-11-20 15:56:37 +08:00
2016-11-28 14:03:54 +08:00
## Showcase
2017-03-10 05:19:57 +08:00
2017-06-02 17:41:13 +08:00
These projects are using docsify to generate their sites. Pull requests welcome :blush:
2016-11-28 14:03:54 +08:00
2019-04-26 11:25:17 +08:00
Move to [awesome-docsify ](https://github.com/docsifyjs/awesome-docsify#showcase )
2016-11-28 14:03:54 +08:00
2016-12-23 09:25:30 +08:00
## Similar projects
2017-03-10 05:19:57 +08:00
2018-01-23 23:52:12 +08:00
| Project | Description |
| ------------------------------------------------ | ---------------------------------------- |
| [docute ](https://github.com/egoist/docute ) | 📜 Effortlessly documentation done right |
| [docpress ](https://github.com/docpress/docpress ) | Documentation website generator |
2016-12-23 09:25:30 +08:00
2016-12-20 22:32:56 +08:00
## Contributing
2016-11-26 18:37:17 +08:00
2018-06-29 22:22:14 +08:00
- 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
2016-12-20 22:32:56 +08:00
## Development
2017-01-10 23:55:58 +08:00
```bash
2017-07-20 00:41:46 +08:00
npm run bootstrap & & npm run dev
2016-12-20 22:32:56 +08:00
```
2016-11-26 18:37:17 +08:00
2018-01-23 23:52:12 +08:00
## 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 >
2018-02-11 15:04:31 +08:00
## Contributors
This project exists thanks to all the people who contribute. [[Contribute ](CONTRIBUTING.md )].
2018-07-01 13:48:44 +08:00
< a href = "https://github.com/docsifyjs/docsify/graphs/contributors" > < img src = "https://opencollective.com/docsify/contributors.svg?width=890" / > < / a >
2018-02-11 15:04:31 +08:00
2016-11-20 15:56:37 +08:00
## License
2017-03-10 05:19:57 +08:00
2018-10-31 22:28:21 +08:00
[MIT ](LICENSE )
2017-06-01 02:30:23 +08:00
2018-07-01 13:48:44 +08:00
[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify?ref=badge_large)
