# vuepress-plugin-check-md2

> > `vuepress check-md` - Check dead links of markdown.

Latest version **1.0.5** (published 2024-03-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install vuepress-plugin-check-md2
pnpm add vuepress-plugin-check-md2
yarn add vuepress-plugin-check-md2
bun add vuepress-plugin-check-md2
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2024-03-22 |
| First published | 2023-12-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 17.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | LXH |
| Maintainers | liuxiaohang |

## Links

- npm: https://www.npmjs.com/package/vuepress-plugin-check-md2
- Repository: https://github.com/StrivingRabbit/vuepress-plugin-check-md2
- Homepage: https://github.com/StrivingRabbit/vuepress-plugin-check-md2#readme
- Issues: https://github.com/StrivingRabbit/vuepress-plugin-check-md2/issues
- npm.io page: https://npm.io/package/vuepress-plugin-check-md2

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [globby](https://npm.io/package/globby.md) ^9.1.0
- [commander](https://npm.io/package/commander.md) ^2.19.0
- [diacritics](https://npm.io/package/diacritics.md) ^1.3.0
- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) ^0.8.0

## Recent versions

- 1.0.5 (latest) — 2024-03-22
- 1.0.4 — 2023-12-27
- 1.0.3 — 2023-12-26
- 1.0.2 — 2023-12-26
- 1.0.1 — 2023-12-26

## README

# vuepress-plugin-check-md2

> `vuepress check-md` - Check dead links of markdown.

**This plugin is powered by [check-md](https://github.com/whxaxes/check-md) made with ❤️ by [@whxaxes](https://github.com/whxaxes).**

## Features

This plugin help check following types of dead links

- Empty link.
- Non-existed target markdown file.
- Non-slugified hash.
- Non-existed hash.
- Prefer `.md` to `.html` (`warn`)

## Install

```bash
yarn add -D vuepress-plugin-check-md2
# OR npm install -D vuepress-plugin-check-md
```

## Usage

```javascript
module.exports = {
  plugins: ['check-md2']
}
```

```bash
vuepress check-md2 [docsDir]
```

### Passing Options

```javascript
module.exports = {
  plugins: ['check-md2', {
    pattern: '**/*.md'
  }]
}
```

## Options

Following options can also be passed via CLI options, e.g. `vuepress check-md2 --fix`

### fix

- Type: `boolean`
- Default: `false`

Check and try to fix

### pattern

- Type: `GlobPattern`
- Default: `**/*.md`

[Glob](https://github.com/isaacs/node-glob) pattern of resolved markdowns.

### ignore

- Type: `GlobPattern`
- Default: `**/node_modules`

[Glob](https://github.com/isaacs/node-glob) pattern to specify paths from being checked.

### exitLevel

- Type: `'none' | 'info' | 'warn' | 'error'`
- Default: `'error'`

Process exit level, default to `error`, other choice is warn and none, it will not exit if setting to none.

### filter

- TYpe: `Function`
- Default: `() => true`

Filter function to filter out some links.

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