diff --git a/README.md b/README.md index 7c272f53..d749ad53 100644 --- a/README.md +++ b/README.md @@ -11,86 +11,86 @@

Travis Status npm - Discord + Chat donate

+

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) +* [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) ## 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)) +* 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/). -## Browser Support - -Modern browsers and Internet Explorer 10+. - ## Showcase These projects are using docsify to generate their sites. Pull requests welcome :blush: -| Project | Description | -|---|---| -| [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 | -| [JS MythBusters](https://mythbusters.js.org) | An optimization handbook from a high level point of view. | -| [hire-me](https://fvcproductions.github.io/hire-me) | A path to getting an awesome tech gig. | -| [vue-amap](https://elemefe.github.io/vue-amap/) | A Map Component Library Base on Vue 2.x and Gaode Map. | -| [samlify](https://samlify.js.org) | Node.js SAML2 library | -| [palettify](https://dobromir-hristov.github.io/palettify/) | A color palette effects assistant | -| [commitlint](https://marionebl.github.io/commitlint/) | Lint commit messages | -| [vue-data-tables](https://github.com/njleonzhang/vue-data-tables/) | A simple and customizable data table, based on vue2 and element-ui. | -| [Noty](http://ned.im/noty/) | A Dependency-free notification library | -| [xTeko](https://docs.xteko.com/) | Addins framework for Pin 3.0 | -| [vue2-datatable-component](https://github.com/OneWayTech/vue2-datatable) | The best Datatable for Vue.js 2.x which never sucks | -| [Solidarity](https://infinitered.github.io/solidarity/) | Environment enforcer for your projects across machines. | -| [rnback](https://rnback.com/) | Backend service for react-native applications. | -| [IT-films](https://greybax.github.com/IT-films/) | A curated list of awesome movies, documentaries and TV series about hackers, geeks and IT in common, sorted by IMDB rating. | -| [zooming](http://desmonding.me/zooming/docs) | Image zoom that makes sense. | -| [vue-sticker](https://kamilocean.github.io/vue-sticker/#/) | Vue component, that helps to make sticky effects | -| [Ts.ED](https://romakita.github.io/ts-express-decorators/#/) | A TypeScript Framework on top of Express | -| [Ts.LogDebug](https://romakita.github.io/ts-log-debug/#/) | A multi channel logger written in TypeScript | -| [vue-orgchart](https://spiritree.github.io/vue-orgchart) | Vue.js wrapper for OrgChart.js | -| [Vue Content Loading](https://lucasleandro1204.github.io/vue-content-loading) | Easily build (or use presets) SVG loading cards Facebook like | -| [preact-analysis](https://sinkmind.github.io/preact-analysis/) | Preact 源码解析 | -| [Tracy Debugger for ProcessWire](https://adrianbj.github.io/TracyDebugger) | The ultimate debugging and development tool for the ProcessWire CMF/CMS | -| [CBoard](https://yzhang921.github.io/cboard_doc) | An easy to use, self-service open BI reporting and BI dashboard platform. | - +| Project | Description | +| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| [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 | +| [JS MythBusters](https://mythbusters.js.org) | An optimization handbook from a high level docsifynt of view. | +| [hire-me](https://fvcproductions.github.io/hire-me) | A path to getting an awesome tech gig. | +| [vue-amap](https://elemefe.github.io/vue-amap/) | A Map Component Library Base on Vue 2.x and Gaode Map. | +| [samlify](https://samlify.js.org) | Node.js SAML2 library | +| [palettify](https://dobromir-hristov.github.io/palettify/) | A color palette effects assistant | +| [commitlint](https://marionebl.github.io/commitlint/) | Lint commit messages | +| [vue-data-tables](https://github.com/njleonzhang/vue-data-tables/) | A simple and customizable data table, based on vue2 and element-ui. | +| [Noty](http://ned.im/noty/) | A Dependency-free notification library | +| [xTeko](https://docs.xteko.com/) | Addins framework for Pin 3.0 | +| [vue2-datatable-component](https://github.com/OneWayTech/vue2-datatable) | The best Datatable for Vue.js 2.x which never sucks | +| [Solidarity](https://infinitered.github.io/solidarity/) | Environment enforcer for your projects across machines. | +| [rnback](https://rnback.com/) | Backend service for react-native applications. | +| [IT-films](https://greybax.github.com/IT-films/) | A curated list of awesome movies, documentaries and TV series about hackers, geeks and IT in common, sorted by IMDB rating. | +| [zooming](http://desmonding.me/zooming/docs) | Image zoom that makes sense. | +| [vue-sticker](https://kamilocean.github.io/vue-sticker/#/) | Vue component, that helps to make sticky effects | +| [Ts.ED](https://romakita.github.io/ts-express-decorators/#/) | A TypeScript Framework on top of Express | +| [Ts.LogDebug](https://romakita.github.io/ts-log-debug/#/) | A multi channel logger written in TypeScript | +| [vue-orgchart](https://spiritree.github.io/vue-orgchart) | Vue.js wrapper for OrgChart.js | +| [Vue Content Loading](https://lucasleandro1204.github.io/vue-content-loading) | Easily build (or use presets) SVG loading cards Facebook like | +| [preact-analysis](https://sinkmind.github.io/preact-analysis/) | Preact 源码解析 | +| [Tracy Debugger for ProcessWire](https://adrianbj.github.io/TracyDebugger) | The ultimate debugging and development tool for the ProcessWire CMF/CMS | +| [CBoard](https://yzhang921.github.io/cboard_doc) | An easy to use, self-service open BI reporting and BI dashboard platform. | ## Similar projects -| Project | Description | -|---|---| -| [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right | -| [docpress](https://github.com/docpress/docpress) | Documentation website generator | +| 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 - +* 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 @@ -99,9 +99,29 @@ 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)] + + + + + + + + + + + + ## 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) -