|
| 1 | +# README |
| 2 | + |
| 3 | +>**Important:** Once installed the checker will only update if you add the setting `"spellMD.enable": true` to your `.vscode\settings.json` file. |
| 4 | +
|
| 5 | +This README covers off: |
| 6 | +* [Functionality](#functionality) |
| 7 | +* [Install](#install) |
| 8 | +* [Run and Configure](#run-and-configure) |
| 9 | +* [Known Issues/Bugs](#known-issuesbugs) |
| 10 | +* [Backlog](#backlog) |
| 11 | +* [How to Debug](#how-to-debug) |
| 12 | + |
| 13 | +# Functionality |
| 14 | + |
| 15 | +Load up a Markdown file and get highlights and hovers for existing issues. Checking will occur as you type in the document. |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +The status bar lets you quickly navigate to any issue and you can see all positions in the gutter. |
| 20 | + |
| 21 | +[](http://shouldnottouchthis/) |
| 22 | +[](https://github.com/username/repository/blob/HEAD/monkey) |
| 23 | + |
| 24 | +<img src="https://github.com/username/repository/raw/HEAD/images/myImage.gif"> |
| 25 | + |
| 26 | +The `spellMD.json` config file is watched so you can add more ignores or change mappings at will. |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +[mono](https://github.com/username/repository/blob/HEAD/monkey) |
| 33 | +[not](http://shouldnottouchthis/) |
| 34 | +[Email me ](mailto:[email protected]) |
| 35 | + |
| 36 | +# Install |
| 37 | +This extension is published in the VS Code Gallery. So simply hit 'F1' and type 'ext inst' from there select `SpellMD` and follow instructions. |
| 38 | + |
| 39 | + |
| 40 | +To clone the extension and load locally... |
| 41 | + |
| 42 | +``` |
| 43 | +git clone https://github.com/Microsoft/vscode-SpellMD.git |
| 44 | +npm install |
| 45 | +tsc |
| 46 | +``` |
| 47 | + |
| 48 | +>**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`. |
0 commit comments