A magical documentation site generator.
- Documentation
- CLI
- CDN: UNPKG | jsDelivr
- 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)
Create an index.html
.
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
</body>
</html>
Modern browsers and Internet Explorer 10+.
These projects are using docsify to generate their sites. Pull requests welcome π
Project | Description |
---|---|
Snipaste | Snip & Paste |
puck | A small & magical php framework. |
Samaritan | An Algorithmic Trading Framework for Digital Currency. |
Vudash | Powerful, Flexible, Open Source dashboards for anything |
Trilogy | No-hassle SQLite with a Promise-based, document store style API. |
Mybatis-Plus | An enhanced toolkit of Mybatis to simplify development |
JS MythBusters | An optimization handbook from a high level point of view. |
hire-me | A path to getting an awesome tech gig. |
vue-amap | A Map Component Library Base on Vue 2.x and Gaode Map. |
samlify | Node.js SAML2 library |
palettify | A color palette effects assistant |
commitlint | Lint commit messages |
vue-data-tables | A simple and customizable data tableοΌbased on vue2 and element-ui. |
Noty | A Dependency-free notification library |
xTeko | Addins framework for Pin 3.0 |
vue2-datatable-component | The best Datatable for Vue.js 2.x which never sucks |
Project | Description |
---|---|
docute | π Effortlessly documentation done right |
docpress | Documentation website generator |
- 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
npm run bootstrap && npm run dev
open http://localhost:3000
MIT