test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-02 12:10:04 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Migrated repository
796 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
c30af850a1
Go to file
qingwei.li c30af850a1 [build] 4.5.1
2017-11-07 20:03:41 +08:00
.github docs: add docsify-ignore 2017-03-16 08:48:21 +08:00
.vscode chore: add vscode config 2017-10-02 13:26:45 +08:00
build feat: add disqus plugin, closed #123 2017-11-04 13:54:37 +08:00
docs [build] 4.5.1 2017-11-07 20:03:41 +08:00
lib [build] 4.5.1 2017-11-07 20:03:41 +08:00
media Add logo (#28) 2016-12-18 15:30:50 +08:00
packages/docsify-server-renderer [build] 4.5.1 2017-11-07 20:03:41 +08:00
src feat: fetch files with the query params, fixed #303 2017-11-07 20:03:11 +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 chore: ignore ./lib , force add ./lib on release (#283) 2017-10-15 19:20:35 -05:00
.npmignore update helper files 2017-03-18 17:21:59 +01:00
.travis.yml chore: update travisci 2017-09-06 18:25:56 +08:00
app.js chore: prettier code 2017-09-22 10:07:10 +08:00
CHANGELOG.md chore: add changelog 4.5.0 2017-11-04 13:56:25 +08:00
dev.html chore: update template 2017-10-30 21:58:33 +08:00
HISTORY.md chore: add history.md 2017-07-20 01:15:39 +08: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 chore: add changelog 4.5.0 2017-11-04 13:56:25 +08:00
package.json chore: add changelog 4.5.0 2017-11-04 13:56:25 +08:00
README.md Add zooming to showcase (#302) 2017-11-05 00:42:10 -05:00

README.md

docsify

A magical documentation site generator.

Travis Status npm cdnjs donate

Sponsor

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 http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <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.
samlify Node.js SAML2 library
palettify A color palette effects assistant
commitlint Lint commit messages
vue-data-tables A simple and customizable data table，based on vue2 and element-ui.
Noty A Dependency-free notification library
xTeko Addins framework for Pin 3.0
vue2-datatable-component The best Datatable for Vue.js 2.x which never sucks
Solidarity Environment enforcer for your projects across machines.
rnback Backend service for react-native applications.
IT-films A curated list of awesome movies, documentaries and TV series about hackers, geeks and IT in common, sorted by IMDB rating.
zooming Image zoom that makes sense.

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 run bootstrap && npm run dev
open http://localhost:3000

License

MIT

FOSSA Status