A magical documentation site generator.
## Links - [Documentation](https://docsify.js.org) - [CLI](https://github.com/QingWei-Li/docsify-cli) ## Features - No statically built html files - Simple and lightweight (~16kB gzipped) - Smart full-text search plugin - Multiple themes - Useful plugin API - Compatible with IE10+ ## Quick start Create a `index.html`. ```html ``` ## Browser Support Modern browsers and Internet Explorer 10+. ## Showcase These open-source projects are using docsify to generate their sites. Pull requests welcome :blush: - [Snipaste](https://docs.snipaste.com/) - Snip & Paste - [puck](https://puck.zz173.com/) - A small & magical php framework. - [Samaritan](http://samaritan.stockdb.org) - An Algorithmic Trading Framework for Digital Currency. - [Vudash](http://vudash.github.io/vudash/) - Powerful, Flexible, Open Source dashboards for anything - [Trilogy](http://trilogy.js.org) - No-hassle SQLite with a Promise-based, document store style API. - [Mybatis-Plus](http://mp.baomidou.com/) - An enhanced toolkit of Mybatis to simplify development ## Similar projects - [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 i && npm run dev open http://localhost:3000 ``` ## License MIT