QingWei-Li / docsify
- четверг, 1 июня 2017 г. в 03:11:46
https://github.com/QingWei-Li/docsify
JavaScript
🃏 A magical documentation site generator.
A magical documentation site generator.
Links
Features
- No statically built html files
- Simple and lightweight (~16kB gzipped)
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Compatible with IE10+
- Support SSR (example)
Quick start
Create an index.html.
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
</body>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</html>Browser Support
Modern browsers and Internet Explorer 10+.
Showcase
These open-source 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. |
Similar projects
| Project | Description |
|---|---|
| docute | |
| 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
npm i && npm run dev
open http://localhost:3000License
MIT