mirror of
https://github.com/zhigang1992/docsify.git
synced 2026-04-01 12:43:06 +08:00
A magical documentation site generator.
Links
Features
- Easy and lightweight (~12kB gzipped)
- Custom themes
- No build
Quick start
Create a 404.html and README.md into /docs.
404.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>
Or 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>
Showcase
These open-source projects are using docsify to generate their sites. Pull requests welcome : )
How to contribute
- Fork it!
- Run
npm i && npm run dev - open
localhost:3000
License
MIT