Skip to content

Latest commit

 

History

History

README.md

CSpell Markdown Dictionary

Markdown dictionary for cspell.

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

Requirements

Tool Version
cspell >= 8
Code Spell Checker - Visual Studio Code >= 4

Local Installation

This package is bundled with CSpell.

Configuration

VSCode Settings

Add the following to your VSCode settings:

.vscode/settings.json

{
  "cSpell.dictionaries": [],
}
CSpell Settings cspell.json

cspell.json

{
  "dictionaries": [],
}
CSpell Settings cspell.config.yaml

cspell.config.yaml

dictionaries: []

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

Contributing

Please help correct any mistakes in the dictionaries.

See: Contributing

Special thanks to all of our amazing contributors!

Dictionary Development

See: How to Create a New Dictionary

License

MIT

Some packages may have other licenses included.



Brought to you by Street Side Software Logo Street Side Software