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
994 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
94bc415534
Go to file
John Hildenbiddle 94bc415534 feat: Add docsify version to $window.docsify object (#641) 
Fix #521

Please makes sure these boxes are checked before submitting your PR, thank you!

* [ x ] Make sure you are merging your commits to `master` branch.
* [ x ] Add some descriptions and refer relative issues for you PR.
* [ x ] DO NOT include files inside `lib` directory.
2018-10-23 15:26:55 +08:00
.github chore: typo 2018-02-11 22:22:06 +08:00
.vscode chore: add vscode config 2017-10-02 13:26:45 +08:00
build feat: Add docsify version to $window.docsify object (#641) 2018-10-23 15:26:55 +08:00
docs chore: README: various small tweaks (#651) 2018-10-23 15:01:55 +08:00
lib fix: improve external script plugin (#632) 2018-10-23 14:58:24 +08:00
packages/docsify-server-renderer [build] 4.7.1 2018-08-30 12:09:24 +08:00
src feat: Add docsify version to $window.docsify object (#641) 2018-10-23 15:26:55 +08:00
.eslintignore refactor: build config (#408) 2018-03-03 22:51:27 +08:00
.eslintrc refactor: build config (#408) 2018-03-03 22:51:27 +08:00
.gitignore chore: fix 'dev' script failed 2018-07-05 17:54:13 +08: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
CHANGELOG.md chore: add changelog 4.7.1 2018-08-30 12:09:25 +08:00
CONTRIBUTING.md chore: Activating Open Collective (#367) 2018-02-11 15:04:31 +08:00
HISTORY.md Fix typos (#326) 2017-12-16 12:06:12 +08:00
index.html chore: fix edit docs button, fixed #562 2018-07-05 17:48:05 +08:00
lerna.json add lerna 2017-05-31 10:01:15 +08:00
LICENSE Update LICENSE 2017-12-26 18:01:57 +08:00
package-lock.json feat: Add docsify version to $window.docsify object (#641) 2018-10-23 15:26:55 +08:00
package.json feat: Add docsify version to $window.docsify object (#641) 2018-10-23 15:26:55 +08:00
README.md Fix typo and update open collective gold sponsor URL (#648) 2018-10-18 22:56:00 +08:00
server.js chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00

README.md

docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Travis Status npm donate gitter

Gold Sponsor via Open Collective

Links

Features

  • No statically built html files
  • Simple and lightweight (~19kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE10+
  • Support SSR (example)
  • Support embedded files

Quick start

Look at this tutorial or online demo.

Showcase

These projects are using docsify to generate their sites. Pull requests welcome 😊

Move to awesome-docsify

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

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Contributors

This project exists thanks to all the people who contribute. [Contribute].

License

MIT

FOSSA Status