jyapayne/docsify: 🃏 A magical documentation site generator.

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

Find a file

qingwei.li 0101492dd4 Update doc		2016-12-20 22:04:55 +08:00
build	0.7.0 (#16 )	2016-11-30 21:33:44 +08:00
docs	Update doc	2016-12-20 22:04:55 +08:00
lib	bump 1.2.0	2016-12-20 21:20:08 +08:00
media	Add logo (#28 )	2016-12-18 15:30:50 +08:00
src	Feat/1.2 (#33 )	2016-12-20 21:18:52 +08:00
.eslintrc	first commit	2016-11-20 15:56:37 +08:00
.gitignore	0.7.0 (#16 )	2016-11-30 21:33:44 +08:00
.travis.yml	Add progress bar and auto2top (#27 )	2016-12-16 22:37:21 +08:00
404.dev.html	Add progress bar and auto2top (#27 )	2016-12-16 22:37:21 +08:00
app.js	1.0 features (#21 )	2016-12-08 21:11:18 +08:00
CHANGELOG.md	Feat/1.2 (#33 )	2016-12-20 21:18:52 +08:00
LICENSE	first commit	2016-11-20 15:56:37 +08:00
package.json	-> v1.2.0	2016-12-20 21:20:18 +08:00
README.md	Add cdn	2016-12-20 10:20:56 +08:00

README.md

A magical documentation site generator.

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

UNPKG https://unpkg.com/docsify/
jsDelivr http://www.jsdelivr.com/projects/docsify

Showcase

These open-source projects are using docsify to generate their sites. Pull requests welcome : )

docsify - A magical documentation site generator.
Snipaste - A new way to boost your productivity.

How to contribute

Fork it!
Run npm i && npm run dev
open localhost:3000

License

MIT