docsify/README.md

A magical documentation site generator.

Gold Sponsor via Open Collective

Links

• develop branch preview
• Documentation
• CLI
• CDN:
  • UNPKG
  • jsDelivr
  • cdnjs
• Awesome docsify
• Community chat

Features

• No statically built html files
• Simple and lightweight
• Smart full-text search plugin
• Multiple themes
• Useful plugin API
• Support embedded files

Quick start

Look at this tutorial

Showcase

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

Move to awesome-docsify

Similar projects

Project	Description
Docusaurus	Docusaurus makes it easy to maintain Open Source documentation websites
GitBook	Where technical teams document
MkDocs	Project documentation with Markdown
VuePress	Vue-powered Static Site Generator

Contributing

See CONTRIBUTING.md.

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

A preview of Docsify's PR and develop branch is Powered by