# @cspell/dict-markdown

> Markdown dictionary for cspell.

Latest version **2.0.18** (published 2026-08-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cspell/dict-markdown
pnpm add @cspell/dict-markdown
yarn add @cspell/dict-markdown
bun add @cspell/dict-markdown
```

## Health

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

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

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 2.0.18 |
| Published | 2026-08-19 |
| First published | 2022-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 289 |
| Author | Street Side Software |
| Maintainers | jason-dent |
| Keywords | cspell, cspell-ext, markdown, Markdown, dictionary, spelling |

## Links

- npm: https://www.npmjs.com/package/@cspell/dict-markdown
- Repository: https://github.com/streetsidesoftware/cspell-dicts
- Homepage: https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/markdown#readme
- Issues: https://github.com/streetsidesoftware/cspell-dicts/issues
- npm.io page: https://npm.io/package/@cspell/dict-markdown

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 2.0.18 (latest) — 2026-08-19
- 2.0.17 — 2026-05-31
- 2.0.16 — 2026-03-09
- 2.0.15 — 2026-03-02
- 2.0.14 — 2025-12-17
- 2.0.13 — 2025-11-27
- 2.0.12 — 2025-07-09
- 2.0.11 — 2025-06-12
- 2.0.10 — 2025-04-01
- 2.0.9 — 2025-01-08
- 2.0.8 — 2024-12-30
- 2.0.7 — 2024-10-23
- 2.0.6 — 2024-10-22
- 2.0.5 — 2024-10-11
- 2.0.2 — 2024-05-22
- … 4 more at https://npm.io/package/@cspell/dict-markdown/versions

## README

# CSpell Markdown Dictionary

Markdown dictionary for cspell.

This is a pre-built dictionary for use with CSpell.

<!--- @@inject: ../../static/requirements.md --->

## Requirements

| Tool                                                                                                                                 | Version |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| [cspell](https://github.com/streetsidesoftware/cspell)                                                                               | `>= 8`  |
| [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4`  |

<!--- @@inject-end: ../../static/requirements.md --->

<!--- @@inject: ./static/install.md --->

## Local Installation

**This package is bundled with CSpell.**

## Configuration

<details>
<summary>VSCode Settings</summary>

Add the following to your VSCode settings:

**`.vscode/settings.json`**

```jsonc
{
  "cSpell.dictionaries": [],
}
```

</details>

<details>
<summary>CSpell Settings <code>cspell.json</code></summary>

**`cspell.json`**

```jsonc
{
  "dictionaries": [],
}
```

</details>

<details>
<summary>CSpell Settings <code>cspell.config.yaml</code></summary>

**`cspell.config.yaml`**

```yaml
dictionaries: []
```

</details>

## Local Installation using CDN

> **NOTE:** This package is bundled with CSpell.

## Dictionary Information

| Name                   | Enabled | Description |
| ---------------------- | ------- | ----------- |
| `html`                 |         | _External_  |
| `html-symbol-entities` |         | _External_  |
| `typescript`           |         | _External_  |
| `css`                  |         | _External_  |

## Language Settings

| Name                   | Locale | File Type         |
| ---------------------- | ------ | ----------------- |
| `html`                 | `*`    | `markdown`, `mdx` |
| `html-symbol-entities` | `*`    | `markdown`, `mdx` |
| `typescript`           | `*`    | `mdx`             |
| `css`                  | `*`    | `mdx`             |

## Predefined Patterns

Predefined patterns can be used to ignore or include sequences of text to be spell checked.

The following patterns are defined in this dictionary:

| Name                      | Description                                                                                    |
| ------------------------- | ---------------------------------------------------------------------------------------------- |
| `MARKDOWN-link-reference` | Markdown reference link: `[This is a link][reference]`, matches `[reference]`                  |
| `MARKDOWN-link-footer`    | Markdown referenced link: `[reference]: https://www.google.com`, matches the entire reference. |
| `MARKDOWN-link`           | Markdown link: `[link text](link)`, matches `link`                                             |
| `MARKDOWN-anchor`         | Markdown Anchors: `<a id="my_link"></a>`, matches `my_link`                                    |

<!--- @@inject-end: ./static/install.md --->

<!--- @@inject: ../../static/contributing.md --->

## Contributing

Please help correct any mistakes in the dictionaries.

See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)

Special thanks to all of our amazing contributors!

### Dictionary Development

See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)

<!--- @@inject-end: ../../static/contributing.md --->

## License

MIT

> Some packages may have other licenses included.

<!--- @@inject: ../../static/footer.md --->

<br/>

---

<p align="center">
Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
</a>
</p>

<!--- @@inject-end: ../../static/footer.md --->

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