test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-02 20:20:30 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Migrated repository
142 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
668c5ca714
Go to file
qingwei.li 668c5ca714 fix lint
2016-12-23 21:47:15 +08:00
build 0.7.0 (#16) 2016-11-30 21:33:44 +08:00
docs Fixed cover rendering timing 2016-12-23 21:46:12 +08:00
lib bump 1.3.2 2016-12-23 01:20:47 +08:00
media Add logo (#28) 2016-12-18 15:30:50 +08:00
src fix lint 2016-12-23 21:47:15 +08:00
.eslintrc first commit 2016-11-20 15:56:37 +08:00
.gitignore Fixed render link 2016-12-23 01:20:28 +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 Fixed cover rendering timing 2016-12-23 21:46:12 +08:00
LICENSE first commit 2016-11-20 15:56:37 +08:00
package.json -> v1.3.2 2016-12-23 01:20:57 +08:00
README.md Add similar projects into readme 2016-12-23 09:25:30 +08:00

README.md

docsify

A magical documentation site generator.

Travis Status npm code style

Links

Features

  • Simple and lightweight (~12kb gzipped)
  • Multiple themes
  • Not build static html files

Quick start

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>

Or create a 404.html and README.md into /docs. Just remove data-router

<script src="//unpkg.com/docsify"></script>

CDN

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.

Similar projects

  • docute - 📜 Effortlessly documentation done right
  • docpress - Documentation website generator

Contributing

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request :D

Development

npm i && npm run dev
open http://localhost:3000

License

MIT