docsify

A magical documentation site generator.

Travis Status npm code style

## Links - [Documentation](https://docsify.js.org) - [CLI](https://github.com/QingWei-Li/docsify-cli) ## Features - Simple and lightweight (~13kB gzipped) - Multiple themes - Not build static html files ## Quick start Create a `index.html` and using `hash router`. index.html ```html
``` ## CDN - UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/) - jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify) ## Showcase These open-source projects are using docsify to generate their sites. Pull requests welcome : ) - [docsify](https://docsify.js.org) - A magical documentation site generator. - [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity. - [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. ## 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 :D ## Development ### prepare ```bash npm i && npm run dev open http://localhost:3000 ``` ### More Language Highlight ```html ``` ## License MIT