iotcat
/
docsify
mirror of https://github.com/IoTcat/docsify.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
739 Commits
6 Branches
177 Tags
3.3 MiB
 
 
 
 
Tag: Branch: Tree: e307308a78
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e307308a78'
${ noResults }
Go to file
qingwei.li e307308a78
chore: add vscode config 		7 years ago
.github docs: add docsify-ignore 7 years ago
.vscode chore: add vscode config 7 years ago
build chore: prettier code 7 years ago
docs docs: Add new copy-to-clipboard plugin (#265) 7 years ago
lib [build] 4.3.6 7 years ago
media Add logo (#28) 8 years ago
packages/docsify-server-renderer chore: prettier code 7 years ago
src fix(slugify): GitHub compatible heading links, fixed #267 7 years ago
.eslintignore refactor(ssr): for test 7 years ago
.eslintrc refactor(ssr): for test 7 years ago
.gitignore update helper files 7 years ago
.npmignore update helper files 7 years ago
.travis.yml chore: update travisci 7 years ago
CHANGELOG.md chore: add changelog 4.3.6 7 years ago
HISTORY.md chore: add history.md 7 years ago
LICENSE Update license 7 years ago
README.md Add vue2-datatable-component in Showcase (#255) 7 years ago
app.js chore: prettier code 7 years ago
dev.html chore: add lockfile 7 years ago
lerna.json add lerna 7 years ago
package-lock.json chore: add changelog 4.3.6 7 years ago
package.json chore: add changelog 4.3.6 7 years ago

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

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