# @vuepress/markdown

> markdown for vuepress

Latest version **1.9.10** (published 2023-08-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vuepress/markdown
pnpm add @vuepress/markdown
yarn add @vuepress/markdown
bun add @vuepress/markdown
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: no vulnerabilities; popular repo.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.9.10 |
| Published | 2023-08-14 |
| First published | 2018-09-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 22.1 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 22731 |
| Author | Evan You |
| Maintainers | ulivz, yyx990803, newsbielt703, bencodezen, kefranabg, meteorlxy |
| Keywords | documentation, generator, markdown, vue, vuepress |

## Links

- npm: https://www.npmjs.com/package/@vuepress/markdown
- Repository: https://github.com/vuejs/vuepress
- Homepage: https://github.com/vuejs/vuepress/blob/master/packages/@vuepress/markdown#readme
- Issues: https://github.com/vuejs/vuepress/issues
- npm.io page: https://npm.io/package/@vuepress/markdown

## Dependencies (7)

- [prismjs](https://npm.io/package/prismjs.md) ^1.13.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^8.4.1
- [markdown-it-chain](https://npm.io/package/markdown-it-chain.md) ^1.3.0
- [markdown-it-emoji](https://npm.io/package/markdown-it-emoji.md) ^1.4.0
- [markdown-it-anchor](https://npm.io/package/markdown-it-anchor.md) ^5.0.2
- [@vuepress/shared-utils](https://npm.io/package/@vuepress/shared-utils.md) 1.9.10
- [markdown-it-table-of-contents](https://npm.io/package/markdown-it-table-of-contents.md) ^0.4.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.9.10 (latest) — 2023-08-14
- 2.0.0-rc.31 (next) — 2026-07-24
- 2.0.0-rc.27 (next-beta) — 2026-03-10
- 2.0.0-rc.30 — 2026-05-14
- 2.0.0-rc.29 — 2026-05-08
- 2.0.0-rc.28 — 2026-04-01
- 2.0.0-rc.26 — 2025-10-14
- 2.0.0-rc.25 — 2025-08-26
- 2.0.0-rc.24 — 2025-06-30
- 2.0.0-rc.23 — 2025-05-08
- 2.0.0-rc.22 — 2025-04-28
- 2.0.0-rc.21 — 2025-04-12
- 2.0.0-rc.20 — 2025-02-23
- 2.0.0-rc.19 — 2024-12-11
- 2.0.0-rc.18 — 2024-10-10
- … 181 more at https://npm.io/package/@vuepress/markdown/versions

## README

# @vuepress/markdown

> markdown library for VuePress

## Public API

### PLUGINS

A map [constant](./lib/constant.js) containing the names of all built-in markdown-it plugins.

### isRequiredPlugin(pluginName: string)

- **Usage**:

```js
const { isRequiredPlugin } = require('@vuepress/markdown')
console.log(isRequiredPlugin(PLUGINS.COMPONENT)) // true
console.log(isRequiredPlugin(PLUGINS.HIGHLIGHT_LINES)) // false
```

### removePlugin(config: chainMarkdown, pluginName: string)

Remove the specified built-in markdown-it plugin in VuePress.

It's needed to use with VuePress’s [Plugin API > chainMarkdown](https://vuepress.vuejs.org/plugin/option-api.html#chainmarkdown).

- **Usage**:

```js
// Your VuePress Plugin or site config.
const { removePlugin } = require('@vuepress/markdown')
module.exports = {
  chainMarkdown (config) {
    removePlugin(config, PLUGINS.HIGHLIGHT_LINES)
  }
}
```

> Note that `PLUGINS.COMPONENT` and `PLUGINS.ANCHOR` are required in VuePress, It is forbidden to delete them!

### removeAllBuiltInPlugins(config: chainMarkdown)

Remove all built-in but not 100% necessary markdown-it plugins in VuePress.

- **Usage**:

```js
// Your VuePress Plugin or site config.
module.exports = {
  chainMarkdown (config) {
    require('@vuepress/markdown').removeAllBuiltInPlugins(config)
  }
}
```

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