Skip to content
forked from docsifyjs/docsify

πŸƒ A magical documentation site generator.

License

Notifications You must be signed in to change notification settings

fuxingyi/docsify

This branch is 652 commits behind docsifyjs/docsify:master.

Folders and files

NameName
Last commit message
Last commit date
Feb 11, 2018
Oct 2, 2017
Mar 3, 2018
Sep 17, 2018
Aug 30, 2018
Aug 30, 2018
Aug 8, 2018
Mar 3, 2018
Mar 3, 2018
Jul 5, 2018
Mar 18, 2017
Sep 6, 2017
Aug 30, 2018
Feb 11, 2018
Dec 16, 2017
Dec 26, 2017
Jul 1, 2018
Jul 5, 2018
May 31, 2017
Aug 30, 2018
Aug 30, 2018
Jul 1, 2018

Repository files navigation

docsify

A magical documentation site generator.

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

Glod 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

About

πŸƒ A magical documentation site generator.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 91.1%
  • CSS 7.7%
  • Other 1.2%