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
801df6ae3e
docsify/README.md
qingwei.li b14fcf7d1c Update readme
2016-12-20 22:34:13 +08:00

2.0 KiB
Raw Blame History

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.

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