# @markdoc/markdoc

> A text markup language for documentation

Latest version **0.5.10** (published 2026-09-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @markdoc/markdoc
pnpm add @markdoc/markdoc
yarn add @markdoc/markdoc
bun add @markdoc/markdoc
```

## Health

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

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

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.5.10 |
| Published | 2026-09-16 |
| First published | 2022-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14.7.0 |
| Dependencies | 0 |
| Unpacked size | 2.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 8487 |
| Author | Ryan Paul |
| Maintainers | mfix-stripe, rpaul-stripe, matv-stripe |

## Links

- npm: https://www.npmjs.com/package/@markdoc/markdoc
- Repository: https://github.com/markdoc/markdoc
- Homepage: https://markdoc.dev
- Issues: https://github.com/markdoc/markdoc/issues
- npm.io page: https://npm.io/package/@markdoc/markdoc

## Recent versions

- 0.5.10 (latest) — 2026-09-16
- 0.5.9 — 2026-08-04
- 0.5.8 — 2026-07-15
- 0.5.7 — 2026-03-26
- 0.5.6 — 2026-03-10
- 0.5.5 — 2026-03-04
- 0.5.4 — 2025-08-05
- 0.5.3 — 2025-08-04
- 0.5.2 — 2025-05-15
- 0.5.1 — 2025-02-11
- 0.5.0 — 2025-02-06
- 0.4.0 — 2023-12-01
- 0.3.5 — 2023-11-08
- 0.3.4 — 2023-10-19
- 0.3.3 — 2023-10-12
- … 20 more at https://npm.io/package/@markdoc/markdoc/versions

## README

<h1 align="center">
  <br>
    <img src="https://user-images.githubusercontent.com/62121649/167893184-a2b69260-ca9e-4a77-a5bc-63b8135ae5db.png" alt="Markdoc" width="260">
  <br>
  <br>
</h1>

<h4 align="center">A powerful, flexible, Markdown-based authoring framework.</h4>

Markdoc is a [Markdown](https://commonmark.org)-based syntax and toolchain for creating custom documentation sites and experiences.  
We designed Markdoc to power [Stripe's public docs](http://stripe.com/docs), our largest and most complex content site.

## Installation

To get started with Markdoc, first install the library:

```shell
npm install @markdoc/markdoc
```

or

```shell
yarn add @markdoc/markdoc
```

and import it in your app:

```js
const Markdoc = require('@markdoc/markdoc');
```

or if you are using ESM

```js
import Markdoc from '@markdoc/markdoc';
```

then use `Markdoc` in your app or tool:

```js
const doc = `
# Markdoc README

{% image src="/logo.svg" /%}
`;

const ast = Markdoc.parse(doc);
const content = Markdoc.transform(ast);
return Markdoc.renderers.react(content, React);
```

Check out [our docs](https://markdoc.dev/docs) for more guidance on how to use Markdoc.

### TypeScript

This is the minimal `tsconfig.json` required to use Markdoc in your TypeScript project:

```json
{
  "compilerOptions": {
    "moduleResolution": "node",
    "target": "esnext", // works with es2015 or greater
    "esModuleInterop": true
  }
}
```

### React

If you are using React, install Markdoc with:

```sh
npm install @markdoc/markdoc react @types/react
```

## Contributing

Contributions and feedback are welcome and encouraged. Check out our [contributing guidelines](.github/CONTRIBUTING.md) on how to do so.

### Development

1. Run `npm install`
1. Run `npm run build`
1. Run the tests using `npm test`

## Code of conduct

This project has adopted the Stripe [Code of conduct](.github/CODE_OF_CONDUCT.md).

## License

This project uses the [MIT license](LICENSE).

## Credits

Special shout out to:

- [@marcioAlmada](https://github.com/marcioAlmada) for providing us with the [@markdoc](https://github.com/markdoc) GitHub org.
- [@koomen](https://github.com/koomen) for gifting us https://markdoc.dev.

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