A magical documentation site generator.

Gold Sponsor via Open Collective

## Links - [`develop` branch preview](https://docsify-preview.vercel.app/) - [Documentation](https://docsify.js.org) - [CLI](https://github.com/docsifyjs/docsify-cli) - CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify) - [Awesome docsify](https://github.com/docsifyjs/awesome-docsify) - [Community chat](https://discord.gg/3NwKFyR) ## 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](https://github.com/docsifyjs/docsify-ssr-demo)) - Support embedded files ## Quick start Look at [this tutorial](https://docsify.js.org/#/quickstart) [![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236) ## Showcase These projects are using docsify to generate their sites. Pull requests welcome :blush: Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase) ## Similar projects | Project | Description | | ------------------------------------------------ | ---------------------------------------- | | [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right | | [docpress](https://github.com/docpress/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. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify) - 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 ```bash npm run bootstrap && npm run dev ``` ## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify#backers)]

## Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/docsify#silver-sponsors)]

## Contributors This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].

## License [MIT](LICENSE) ## Special Thanks A preview of Docsify's PR and develop branch is Powered by Vercel

	Stars	Issues	Version	Updated	Created
docsify			4.13.1	a year ago	7 years ago
documentation	5,768	206	14.0.3	3 months ago	9 years ago
dox	2,156	19	1.0.0	2 years ago	13 years ago
gitbook			2.6.9	6 years ago	10 years ago
jsdoc	14,782	440	4.0.3	13 days ago	13 years ago

docsify vs documentation vs dox vs gitbook vs jsdoc

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past