mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-12-03 04:31:20 +08:00
Migrated repository
| .github | ||
| build | ||
| docs | ||
| lib | ||
| media | ||
| src | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .npmignore | ||
| .travis.yml | ||
| app.js | ||
| CHANGELOG.md | ||
| dev.html | ||
| HISTORY.md | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| yarn.lock | ||
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+
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 |
Similar projects
| Project | Description |
|---|---|
| docute | 📜 Effortlessly documentation done right |
| 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:3000
License
MIT