mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
A magical documentation site generator.
Links
Features
- Simple and lightweight (~12kb gzipped)
- Multiple themes
- Not build static html files
Quick start
Create a index.html and using hash router.
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" data-router></script>
</html>
Or create a 404.html and README.md into /docs. Just remove data-router
<script src="//unpkg.com/docsify"></script>
CDN
Showcase
These open-source projects are using docsify to generate their sites. Pull requests welcome : )
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