A magical documentation site generator.

Glod Sponsor via Open Collective

## Links * [Documentation](https://docsify.js.org) * [CLI](https://github.com/QingWei-Li/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/QingWei-Li/awesome-docsify) ## Features * No statically built html files * Simple and lightweight (~18kB gzipped) * Smart full-text search plugin * Multiple themes * Useful plugin API * Compatible with IE10+ * Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) ## Quick start Look at [this tutorial](https://docsify.js.org/#/quickstart) or [online demo](https://jsfiddle.net/7ztb8qsr/1/). ## Showcase These projects are using docsify to generate their sites. Pull requests welcome :blush: Move to [awesome-docsify](https://github.com/QingWei-Li/awesome-docsify) ## Similar projects | Project | Description | | ------------------------------------------------ | ---------------------------------------- | | [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right | | [docpress](https://github.com/docpress/docpress) | Documentation website generator | ## Contributing * 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 ## Development ```bash npm run bootstrap && npm run dev open http://localhost:3000 ``` ## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify#backers)]

## 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)]

## Contributors This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].

## License MIT [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify?ref=badge_large)