docsify
A magical documentation generator.
Last updated a month ago by sy-records .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install docsify 
SYNC missed versions from official npm registry.

docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Unit tests Suite Linting Checks Testing the e2e test suites npm donate gitter Gitpod Ready-to-Code

Gold Sponsor via Open Collective

Links

Features

  • No statically built html files
  • Simple and lightweight
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE11
  • Support SSR (example)
  • Support embedded files

Quick start

Look at this tutorial

Edit 307qqv236

Showcase

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

Move to awesome-docsify

Similar projects

Project Description
docute ???? Effortlessly documentation done right
docpress Documentation website generator

Contributing

Online one-click setup for Contributing

You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically:

  • clone the docsify repo.
  • install the dependencies.
  • start npm run dev.

So that you can start straight away.

Open in Gitpod

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git add . && git commit -m '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

Special Thanks

Vercel has given us a Pro account.

Current Tags

  • 4.11.6                                ...           latest (a month ago)
  • 4.9.4                                ...           next (a year ago)

187 Versions

  • 4.11.6                                ...           a month ago
  • 4.11.5                                ...           a month ago
  • 4.11.4                                ...           3 months ago
  • 4.11.3                                ...           6 months ago
  • 4.11.2                                ...           7 months ago
  • 4.11.1                                ...           7 months ago
  • 4.11.0                                ...           7 months ago
  • 4.10.2                                ...           9 months ago
  • 4.10.0                                ...           9 months ago
  • 4.9.4                                ...           a year ago
  • 4.9.2                                ...           a year ago
  • 4.9.1                                ...           2 years ago
  • 4.9.0                                ...           2 years ago
  • 4.8.6                                ...           2 years ago
  • 4.8.5                                ...           2 years ago
  • 4.8.4                                ...           2 years ago
  • 4.8.3                                ...           2 years ago
  • 4.8.2                                ...           2 years ago
  • 4.8.1                                ...           2 years ago
  • 4.8.0                                ...           2 years ago
  • 4.7.1                                ...           2 years ago
  • 4.7.0                                ...           2 years ago
  • 4.6.10                                ...           3 years ago
  • 4.6.9                                ...           3 years ago
  • 4.6.8                                ...           3 years ago
  • 4.6.7                                ...           3 years ago
  • 4.6.6                                ...           3 years ago
  • 4.6.5                                ...           3 years ago
  • 4.6.4                                ...           3 years ago
  • 4.6.3                                ...           3 years ago
  • 4.6.2                                ...           3 years ago
  • 4.6.1                                ...           3 years ago
  • 4.6.0                                ...           3 years ago
  • 4.5.9                                ...           3 years ago
  • 4.5.7                                ...           3 years ago
  • 4.5.6                                ...           3 years ago
  • 4.5.5                                ...           3 years ago
  • 4.5.4                                ...           3 years ago
  • 4.5.3                                ...           3 years ago
  • 4.5.2                                ...           3 years ago
  • 4.5.1                                ...           3 years ago
  • 4.5.0                                ...           3 years ago
  • 4.4.1                                ...           3 years ago
  • 4.4.0                                ...           3 years ago
  • 4.3.15                                ...           3 years ago
  • 4.3.14                                ...           3 years ago
  • 4.3.13                                ...           3 years ago
  • 4.3.12                                ...           3 years ago
  • 4.3.11                                ...           3 years ago
  • 4.3.10                                ...           3 years ago
  • 4.3.9                                ...           3 years ago
  • 4.3.8                                ...           3 years ago
  • 4.3.7                                ...           3 years ago
  • 4.3.6                                ...           3 years ago
  • 4.3.5                                ...           3 years ago
  • 4.3.4                                ...           3 years ago
  • 4.3.3                                ...           3 years ago
  • 4.3.2                                ...           3 years ago
  • 4.3.1                                ...           3 years ago
  • 4.3.0                                ...           3 years ago
  • 4.2.9                                ...           3 years ago
  • 4.2.8                                ...           3 years ago
  • 4.2.7                                ...           3 years ago
  • 4.2.6                                ...           3 years ago
  • 4.2.4                                ...           3 years ago
  • 4.2.3                                ...           3 years ago
  • 4.2.2                                ...           3 years ago
  • 4.2.1                                ...           3 years ago
  • 4.2.0                                ...           3 years ago
  • 4.1.14                                ...           3 years ago
  • 4.1.13                                ...           3 years ago
  • 4.1.12                                ...           3 years ago
  • 4.1.11                                ...           3 years ago
  • 4.1.10                                ...           3 years ago
  • 4.1.9                                ...           3 years ago
  • 4.1.8                                ...           3 years ago
  • 4.1.7                                ...           3 years ago
  • 4.1.6                                ...           3 years ago
  • 4.1.5                                ...           3 years ago
  • 4.1.4                                ...           3 years ago
  • 4.1.3                                ...           3 years ago
  • 4.1.2                                ...           3 years ago
  • 4.1.1                                ...           3 years ago
  • 4.1.0                                ...           3 years ago
  • 4.0.2                                ...           3 years ago
  • 4.0.1                                ...           3 years ago
  • 4.0.0                                ...           3 years ago
  • 3.7.3                                ...           3 years ago
  • 3.7.2                                ...           3 years ago
  • 3.7.1                                ...           3 years ago
  • 3.7.0                                ...           3 years ago
  • 3.6.6                                ...           3 years ago
  • 3.6.5                                ...           3 years ago
  • 3.6.4                                ...           3 years ago
  • 3.6.3                                ...           3 years ago
  • 3.6.2                                ...           3 years ago
  • 3.6.1                                ...           3 years ago
  • 3.6.0                                ...           3 years ago
  • 3.5.2                                ...           3 years ago
  • 3.5.1                                ...           4 years ago
  • 3.5.0                                ...           4 years ago
  • 3.4.4                                ...           4 years ago
  • 3.4.3                                ...           4 years ago
  • 3.4.2                                ...           4 years ago
  • 3.4.1                                ...           4 years ago
  • 3.4.0                                ...           4 years ago
  • 3.3.0                                ...           4 years ago
  • 3.2.0                                ...           4 years ago
  • 3.1.2                                ...           4 years ago
  • 3.1.1                                ...           4 years ago
  • 3.1.0                                ...           4 years ago
  • 3.0.5                                ...           4 years ago
  • 3.0.4                                ...           4 years ago
  • 3.0.3                                ...           4 years ago
  • 3.0.2                                ...           4 years ago
  • 3.0.1                                ...           4 years ago
  • 3.0.0                                ...           4 years ago
  • 2.4.3                                ...           4 years ago
  • 2.4.2                                ...           4 years ago
  • 2.4.1                                ...           4 years ago
  • 2.4.0                                ...           4 years ago
  • 2.3.0                                ...           4 years ago
  • 2.2.1                                ...           4 years ago
  • 2.2.0                                ...           4 years ago
  • 2.1.0                                ...           4 years ago
  • 2.0.3                                ...           4 years ago
  • 2.0.2                                ...           4 years ago
  • 2.0.1                                ...           4 years ago
  • 2.0.0                                ...           4 years ago
  • 1.10.5                                ...           4 years ago
  • 1.10.4                                ...           4 years ago
  • 1.10.3                                ...           4 years ago
  • 1.10.2                                ...           4 years ago
  • 1.10.1                                ...           4 years ago
  • 1.10.0                                ...           4 years ago
  • 1.9.0                                ...           4 years ago
  • 1.8.0                                ...           4 years ago
  • 1.7.4                                ...           4 years ago
  • 1.7.3                                ...           4 years ago
  • 1.7.2                                ...           4 years ago
  • 1.7.1                                ...           4 years ago
  • 1.7.0                                ...           4 years ago
  • 1.6.1                                ...           4 years ago
  • 1.6.0                                ...           4 years ago
  • 1.5.2                                ...           4 years ago
  • 1.5.1                                ...           4 years ago
  • 1.5.0                                ...           4 years ago
  • 1.4.3                                ...           4 years ago
  • 1.4.2                                ...           4 years ago
  • 1.4.1                                ...           4 years ago
  • 1.4.0                                ...           4 years ago
  • 1.3.5                                ...           4 years ago
  • 1.3.4                                ...           4 years ago
  • 1.3.3                                ...           4 years ago
  • 1.3.2                                ...           4 years ago
  • 1.3.1                                ...           4 years ago
  • 1.3.0                                ...           4 years ago
  • 1.2.0                                ...           4 years ago
  • 1.1.7                                ...           4 years ago
  • 1.1.6                                ...           4 years ago
  • 1.1.5                                ...           4 years ago
  • 1.1.4                                ...           4 years ago
  • 1.1.3                                ...           4 years ago
  • 1.1.2                                ...           4 years ago
  • 1.1.1                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.3                                ...           4 years ago
  • 1.0.2                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
  • 0.7.0                                ...           4 years ago
  • 0.6.1                                ...           4 years ago
  • 0.6.0                                ...           4 years ago
  • 0.5.0                                ...           4 years ago
  • 0.4.2                                ...           4 years ago
  • 0.4.1                                ...           4 years ago
  • 0.4.0                                ...           4 years ago
  • 0.3.1                                ...           4 years ago
  • 0.3.0                                ...           4 years ago
  • 0.2.1                                ...           4 years ago
  • 0.2.0                                ...           4 years ago
  • 0.1.0                                ...           4 years ago
  • 0.0.5                                ...           4 years ago
  • 0.0.4                                ...           4 years ago
  • 0.0.3                                ...           4 years ago
  • 0.0.2                                ...           4 years ago
  • 0.0.1                                ...           4 years ago
Downloads
Today 6
This Week 665
This Month 2,074
Last Day 93
Last Week 456
Last Month 3,494
Dependencies (8)
Dev Dependencies (34)

Copyright 2014 - 2016 © taobao.org |