test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-11-30 11:08:58 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Migrated repository
84 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
d175ba6913
Go to file
qingwei.li d175ba6913 -> v1.0.2
2016-12-13 22:12:18 +08:00
build 0.7.0 (#16) 2016-11-30 21:33:44 +08:00
docs Update doc 2016-12-08 21:18:01 +08:00
lib bump 1.0.2 2016-12-13 22:11:50 +08:00
src Fix/1.0.2 (#25) 2016-12-13 22:10:58 +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 ci 2016-11-22 22:48:44 +08:00
404.dev.html 1.0 features (#21) 2016-12-08 21:11:18 +08:00
app.js 1.0 features (#21) 2016-12-08 21:11:18 +08:00
CHANGELOG.md Fix/1.0.2 (#25) 2016-12-13 22:10:58 +08:00
LICENSE first commit 2016-11-20 15:56:37 +08:00
package.json -> v1.0.2 2016-12-13 22:12:18 +08:00
README.md 1.0 features (#21) 2016-12-08 21:11:18 +08:00

README.md

docsify

Build Status npm

🃏 A magical documentation site generator.

Links

Features

  • Easy and lightweight
  • 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></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>

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