🃏 A magical documentation site generator.
- Easy and lightweight
- Custom themes
- No build
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></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></body>
<script src="//unpkg.com/docsify" data-router></script>
</html>
These open-source projects are using docsify to generate their sites. Pull requests welcome : )
- Fork it!
- Run
npm i && npm run dev
- open
localhost:3000
MIT