markdown-it-spellcheck

This is a plug-in for markdown-it that you can use to spell-check your markdown files.

It works by hooking into the rendering process of markdown-it, and gives you callbacks that you can use to track any spelling errors or warnings. You can also add words to the custom dictionary, and set up a filter function to allow some pre-processing. You'll need to provide the code for those callbacks; the use-case envisaged is that your test suite checks spellings and can fail a build if errors are found.

A command-line markdown spell-checker, markdown-spellcheck-cli, is available. Refer to example.js (and example.md) for a demo of filtering. The "hello, world" code is as follows.

const fs = require('fs')
const md = require('markdown-it')()  // { html: true } if you use HTML blocks/inline
	.use(require('markdown-it-spellcheck'), {
		errors: (errors) => {
			console.log(`Errors: ${errors.join(', ')}`)
		},
		warnings: (warnings) => {
			console.log(`Warnings: ${warnings.join(', ')}`)
		}
		// log: null,
		// validWords: [],
		// warnWords: [],
		// filter: null
	})

md.render(fs.readFileSync('a-markdown-file.md').toString())

Notes

The contents of inline code and fenced/indented code blocks are not checked.
If you are using inline HTML, or HTML blocks (e.g. if you prefer doing tables with HTML syntax rather than markdown's), you need to set markdown-it's "html" option to true so that the structure of the HTML is interpreted correctly.
The contents of inline HTML tags are checked as if they were part of the body text (e.g. in One fish, <span>two</span> fish, the word "two" is treated as part of the document's text).
HTML <code> elements are not checked, in line with the behaviour for markdown code blocks.

Options

Refer to the core-text-spellcheck options.

There is some extra information regarding the "filter" option...

filter

A callback that is used to process some text before it's passed to the spellchecker. The "text" here means each text token from the markdown-it renderer, so this could be a paragraph, sentence, list item, or text within an inline HTML block.

Consult example.js and example.md for an example of how a filter can be used.

Default value: null

Development

Set-up

Check out the code.
npm install

Useful scripts

npm test—runs the tests (which also happens on pre-commit).
npm run example—runs the example script (it is expected that this returns an error, as it should correctly find a misspelling).