# docsify

> A magical documentation generator.

Latest version **5.0.0** (published 2026-07-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install docsify
pnpm add docsify
yarn add docsify
bun add docsify
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score; popular repo.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2026-07-23 |
| First published | 2016-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=20.11.0 |
| Dependencies | 7 |
| Unpacked size | 3.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 31504 |
| Maintainers | trusktr, qingwei.li, jhildenbiddle, anixsaha, sy-records, koooooo-7 |
| Keywords | client, creator, crs, doc, docs, documentation, generator, markdown |

## Links

- npm: https://www.npmjs.com/package/docsify
- Repository: https://github.com/docsifyjs/docsify
- Homepage: https://docsify.js.org
- Issues: https://github.com/docsifyjs/docsify/issues
- npm.io page: https://npm.io/package/docsify

## Dependencies (7)

- [dexie](https://npm.io/package/dexie.md) ^4.0.11
- [marked](https://npm.io/package/marked.md) ^18.0.3
- [prismjs](https://npm.io/package/prismjs.md) ^1.29.0
- [tinydate](https://npm.io/package/tinydate.md) ^1.3.0
- [common-tags](https://npm.io/package/common-tags.md) ^1.8.0
- [medium-zoom](https://npm.io/package/medium-zoom.md) ^1.1.0
- [opencollective-postinstall](https://npm.io/package/opencollective-postinstall.md) ^2.0.2

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 5.0.0 (latest) — 2026-07-23
- 5.0.0-rc.4 (rc) — 2026-03-11
- 4.9.4 (next) — 2019-05-05
- 5.0.0-rc.3 — 2025-09-05
- 5.0.0-rc.2 — 2025-09-05
- 5.0.0-rc.1 — 2025-05-27
- 4.13.1 — 2023-06-24
- 4.13.0 — 2022-10-26
- 4.12.4 — 2022-10-26
- 4.12.2 — 2022-01-06
- 4.12.1 — 2021-03-07
- 4.12.0 — 2021-02-08
- 4.11.6 — 2020-08-22
- 4.11.5 — 2020-08-21
- 4.11.4 — 2020-06-18
- … 183 more at https://npm.io/package/docsify/versions

## README

<p align="center">
  <a href="https://docsify.js.org">
    <img alt="docsify" src="./docs/_media/icon.svg">
  </a>
</p>

<p align="center">
  A magical documentation site generator.
</p>

<p align="center">
  <a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/docsify/backers/badge.svg?style=flat-square"></a>
  <a href="#sponsors">
    <img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a>
  <a href="https://github.com/docsifyjs/docsify/actions/workflows/test.yml"><img src="https://github.com/docsifyjs/docsify/actions/workflows/test.yml/badge.svg" alt="Build & Test"></a>
  <a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
  <a href="https://discord.gg/3NwKFyR"><img alt="Join Discord community and chat about Docsify" src="https://img.shields.io/discord/713647066802421792.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&cacheSeconds=60"></a>
  <a href="https://gitpod.io/#https://github.com/docsifyjs/docsify"><img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"></a>
</p>

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

<p align="center">
  <a href="https://opencollective.com/docsify/order/3254">
    <img src="https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=48">
  </a>
</p>

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

<a href="https://opencollective.com/docsify#backers" target="_blank"><img src="https://opencollective.com/docsify/backers.svg?width=890"></a>

## Sponsors

Thank you for supporting this project! ❤️ [[Become a sponsor](https://opencollective.com/docsify/contribute)]

<img src="https://opencollective.com/docsify/sponsors.svg?width=890" />

## Contributors

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

<a href="https://github.com/docsifyjs/docsify/graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/docsify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._