README

Important: Once installed the checker will only update if you add the setting "spellMD.enable": true to your .vscode\settings.json file.

This README covers off:

Functionality

Load up a Markdown file and get highlights and hovers for existing issues. Checking will occur as you type in the document.

The status bar lets you quickly navigate to any issue and you can see all positions in the gutter.

The spellMD.json config file is watched so you can add more ignores or change mappings at will.

This extension is published in the VS Code Gallery. So simply hit 'F1' and type 'ext inst' from there select SpellMD and follow instructions.

To clone the extension and load locally...

git clone https://github.com/Microsoft/vscode-SpellMD.git
npm install
tsc

Note: TypeScript 1.6 or higher is required you can check with tsc -v and if you need to upgrade then run npm install -g typescript.