@cspell/dict-markdown/README.md

Markdown dictionary for cspell.

# 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 --->