docsifyjs

docsifyjs/docsify

🃏 A magical documentation site generator.

View on GitHub Website / Demo Back to listing

31.5kstars 5.8kforks 100+contributors JavaScript

README.md

View on GitHub

A magical documentation site generator.

Gold Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a>

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 in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://sandbox.docsifyjs.org/)

## 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)

Repository info

Default branch: develop
Latest version: v5.0.0
Created: 2016-11-20
Last activity: 2026-10-13
License: MIT
Open issues: 109
Watchers: 271

Topics

doc docs docsify documentation documentation-tool github-pages markdown vue

Contributors

QingWei-Li

886 contributions

sy-records

172 contributions

dependabot[bot]

169 contributions

jhildenbiddle

115 contributions

anikethsaha

102 contributions