docsify

<img alt="docsify" src="./docs/_media/icon.svg">

A magical documentation site generator.

<img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a>

Gold Sponsor via Open Collective

<img src="https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36">

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
• Compatible with IE11
• Experimental SSR support (example)
• Support embedded files

Quick start

Look at this tutorial

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 a 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.

• 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

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