mirror of https://github.com/IoTcat/docsify.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qingwei.li
7c6ab54ba7
|
7 years ago | |
|---|---|---|
| build | 7 years ago | |
| docs | 7 years ago | |
| lib | 7 years ago | |
| media | 8 years ago | |
| src | 7 years ago | |
| .eslintrc | 7 years ago | |
| .gitignore | 8 years ago | |
| .travis.yml | 8 years ago | |
| CHANGELOG.md | 7 years ago | |
| HISTORY.md | 7 years ago | |
| LICENSE | 8 years ago | |
| README.md | 7 years ago | |
| app.js | 8 years ago | |
| dev.html | 7 years ago | |
| package.json | 7 years ago | |
| yarn.lock | 8 years ago | |
README.md
A magical documentation site generator.
Links
Features
- Not build static html files
- Simple and lightweight (~13kB gzipped)
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Compatible with IE9+
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 9+.
Showcase
These open-source projects are using docsify to generate their sites. Pull requests welcome : )
- Snipaste - A new way to boost your productivity.
- 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 :D
Development
npm i && npm run dev
open http://localhost:3000
License
MIT