test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-11-30 19:20:06 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Migrated repository
416 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
92d6e8a1ee
Go to file
woshiguabi 92d6e8a1ee Update search.js
2017-02-27 11:45:14 +08:00
build feat(emoji): add emoji plugin 2017-02-22 22:30:07 +08:00
docs docs: update package size 2017-02-24 20:18:17 +08:00
lib bump: 3.1.1 2017-02-24 20:19:34 +08:00
media Add logo (#28) 2016-12-18 15:30:50 +08:00
src Update search.js 2017-02-27 11:45:14 +08:00
.eslintrc refactor(plugins): update search plugin 2017-02-19 14:38:38 +08:00
.gitignore Add yarn.lock 2017-01-12 18:44:41 +08:00
.travis.yml Add progress bar and auto2top (#27) 2016-12-16 22:37:21 +08:00
app.js Fix scroll highlight when Vue exist 2016-12-27 23:58:26 +08:00
CHANGELOG.md bump: 3.1.1 2017-02-24 20:19:34 +08:00
dev.html bump: 3.0.3 2017-02-19 22:52:59 +08:00
HISTORY.md docs: move changelog to history 2017-02-19 14:38:38 +08:00
LICENSE Update license 2017-01-18 16:34:05 +08:00
package.json -> v3.1.1 2017-02-24 20:19:40 +08:00
README.md fix(search): dont search nameLink, fixed #102 2017-02-24 20:18:17 +08:00
yarn.lock Add yarn.lock 2017-01-12 18:44:41 +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+

Quick start

Create a index.html.

<!-- 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"></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 😊

  • 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

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

Development

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

License

MIT