docsify/README.md at d343ff5b21adab16419652a6a984e1f177ad21e9

test/docsify

Fork 0

mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-02 20:20:30 +08:00

qingwei.li d343ff5b21 Update badges

2016-12-18 19:43:58 +08:00

1.8 KiB

Raw Blame History

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>

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

1.8 KiB Raw Blame History