mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
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 a index.html.
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
<div id="app"></div>
</body>
<script src="//unpkg.com/docsify"></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 😊
- 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
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