๐Ÿƒ A magical documentation site generator.
Pull request Compare This branch is 408 commits behind docsifyjs:master.
Fetching latest commitโ€ฆ
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
build
docs
lib
media
packages/docsify-server-renderer
src
.eslintignore
.eslintrc
.gitignore
.npmignore
.travis.yml
CHANGELOG.md
HISTORY.md
LICENSE
README.md
app.js
dev.html
lerna.json
package-lock.json
package.json
yarn.lock

README.md

docsify

A magical documentation site generator.

Travis Status npm donate

Links

Features

  • No statically built html files
  • Simple and lightweight (~18kB 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="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
</head>
<body>
  <div id="app"></div>
  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
</body>
</html>

Browser Support

Modern browsers and Internet Explorer 10+.

Showcase

These 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