test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-01 19:50:32 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Migrated repository
252 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
11f77cd434
Go to file
qingwei.li 11f77cd434 Fix render emojis
2017-01-25 21:16:53 +08:00
build 0.7.0 (#16) 2016-11-30 21:33:44 +08:00
docs bump 1.10.0 2017-01-25 15:08:28 +08:00
lib bump 1.10.0 2017-01-25 15:08:28 +08:00
media Add logo (#28) 2016-12-18 15:30:50 +08:00
src Fix render emojis 2017-01-25 21:16:53 +08:00
.eslintrc first commit 2016-11-20 15:56:37 +08:00
.gitignore Add yarn.lock 2017-01-11 16:53:08 +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 Fix render emojis 2017-01-25 21:16:53 +08:00
dev.html Add name option 2017-01-11 18:11:49 +08:00
LICENSE Update license 2017-01-18 16:34:05 +08:00
package.json -> v1.10.0 2017-01-25 15:08:40 +08:00
README.md Support emoji, closed #61 2017-01-25 15:07:36 +08:00
yarn.lock Add yarn.lock 2017-01-11 16:53:08 +08:00

README.md

docsify

A magical documentation site generator.

Travis Status npm code style

Links

Features

  • Simple and lightweight (~13kB gzipped)
  • Multiple themes
  • Not build static html files
  • Support emoji 😆

Quick start

Create a index.html and using hash router.

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" data-router></script>
</html>

CDN

Showcase

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

  • docsify - A magical documentation site generator.
  • Snipaste - A new way to boost your productivity.
  • 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.

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

Development

prepare

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

More Language Highlight

<script src="//unpkg.com/docsify"></script>
<script src="//unpkg.com/prismjs/components/prism-bash.js"></script>
<script src="//unpkg.com/prismjs/components/prism-php.js"></script>

License

MIT