🃏 A magical documentation site generator.
https://docsify.js.org
|
|
||
|---|---|---|
| build | ||
| docs | ||
| lib | ||
| media | ||
| src | ||
| .eslintrc | ||
| .gitignore | ||
| .travis.yml | ||
| 404.dev.html | ||
| app.js | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
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>
CDN
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