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
609 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
e4d2e7ec12
Go to file
Michelle Brier e4d2e7ec12 Add license report 
Large report badge
2017-06-01 07:43:59 +08:00
.github docs: add docsify-ignore 2017-03-16 08:48:21 +08:00
build fix: auto replace version 2017-05-31 08:25:00 +08:00
docs [build] 4.1.9 2017-05-31 22:32:30 +08:00
lib [build] 4.1.9 2017-05-31 22:32:30 +08:00
media Add logo (#28) 2016-12-18 15:30:50 +08:00
packages/docsify-server-renderer [build] 4.1.8 2017-05-31 08:39:22 +08:00
src fix(lifecycle): continue to handle data 2017-05-31 21:20:09 +08:00
.eslintignore refactor(ssr): for test 2017-05-30 04:28:30 +08:00
.eslintrc refactor(ssr): for test 2017-05-30 04:28:30 +08:00
.gitignore update helper files 2017-03-18 17:21:59 +01:00
.npmignore update helper files 2017-03-18 17:21:59 +01:00
.travis.yml update helper files 2017-03-18 17:21:59 +01:00
app.js refactor(ssr): for test 2017-05-30 04:28:30 +08:00
CHANGELOG.md add changelog 2017-05-31 22:20:46 +08:00
dev.html fix: auto replace version 2017-05-31 08:25:00 +08:00
HISTORY.md update main markdown files 2017-03-09 22:19:57 +01:00
lerna.json add lerna 2017-05-31 10:01:15 +08:00
LICENSE Update license 2017-01-18 16:34:05 +08:00
package-lock.json add package-lock.json 2017-05-31 14:22:43 +08:00
package.json [release] 4.1.9 2017-05-31 22:32:57 +08:00
README.md Add license report 2017-06-01 07:43:59 +08:00
yarn.lock fix(render): broken name link, fixed #167 2017-05-31 20:35:59 +08:00

README.md

docsify

A magical documentation site generator.

Travis Status npm donate

Links

Features

  • No statically built html files
  • Simple and lightweight (~16kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE10+
  • Support SSR (example)

Quick start

Create an index.html.

<!-- index.html -->

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
</head>
<body>
  <div id="app"></div>
</body>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</html>

Browser Support

Modern browsers and Internet Explorer 10+.

Showcase

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

Project Description
Snipaste Snip & Paste
puck A small & magical php framework.
Samaritan An Algorithmic Trading Framework for Digital Currency.
Vudash Powerful, Flexible, Open Source dashboards for anything
Trilogy No-hassle SQLite with a Promise-based, document store style API.
Mybatis-Plus An enhanced toolkit of Mybatis to simplify development
JS MythBusters An optimization handbook from a high level point of view.
hire-me A path to getting an awesome tech gig.
vue-amap A Map Component Library Base on Vue 2.x and Gaode Map.

Similar projects

Project Description
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

Development

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

License

MIT

FOSSA Status