docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Build & Test npm Join Discord community and chat about Docsify Gitpod Ready-to-Code

Gold Sponsor via Open Collective

Docsify turns one or more Markdown files into a Website, with no build process required. ## Features - No statically built HTML files - Simple and lightweight - Smart full-text search plugin - Multiple themes - Useful plugin API - Emoji support ## Quick Start Get going fast by using a static web server or GitHub Pages with this ready-to-use [Docsify Template](https://github.com/docsifyjs/docsify-template), review the [quick start tutorial](https://docsify.js.org/#/quickstart) or jump right into a CodeSandbox example site with the button below. [![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236) ## Showcase A large collection of showcase projects are included in [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase). ## Links - [Documentation](https://docsify.js.org) - [Docsify CLI (Command Line Interface)](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) - [`develop` branch preview](https://docsify-preview.vercel.app/) - [Awesome docsify](https://github.com/docsifyjs/awesome-docsify) - [Community chat](https://discord.gg/3NwKFyR) ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md). ## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify/contribute)] ## Sponsors Thank you for supporting this project! ❤️ [[Become a sponsor](https://opencollective.com/docsify/contribute)] ## Contributors This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. ## License [MIT](LICENSE)