🃏 A magical documentation site generator. https://docsify.js.org

Find a file

qingwei.li 0f966e2eb1 bump 0.6.0		2016-11-29 21:43:29 +08:00
build	customize sidebar and navbar via markdown file, #6 (#8 )	2016-11-29 01:07:47 +08:00
docs	0.6.0 (#12 )	2016-11-29 21:42:48 +08:00
lib	bump 0.6.0	2016-11-29 21:43:29 +08:00
src	0.6.0 (#12 )	2016-11-29 21:42:48 +08:00
themes	0.6.0 (#12 )	2016-11-29 21:42:48 +08:00
.eslintrc	first commit	2016-11-20 15:56:37 +08:00
.gitignore	first commit	2016-11-20 15:56:37 +08:00
.travis.yml	Add ci	2016-11-22 22:48:44 +08:00
404.dev.html	0.6.0 (#12 )	2016-11-29 21:42:48 +08:00
app.js	Add max level option	2016-11-27 13:09:18 +08:00
CHANGELOG.md	0.6.0 (#12 )	2016-11-29 21:42:48 +08:00
LICENSE	first commit	2016-11-20 15:56:37 +08:00
package.json	-> v0.5.0	2016-11-29 01:11:12 +08:00
README.md	fix url	2016-11-28 15:39:35 +08:00

README.md

docsify

🃏 A magical documentation site generator.

Features

Easy and lightweight
Custom themes
No build

Quick start

Create 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>

Showcase

These open-source projects are using docsify to generate their sites.

docsify - A magical documentation site generator.

How to contribute

Fork it and clone!
Run npm i && npm run dev

License

MIT