-
Notifications
You must be signed in to change notification settings - Fork 205
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use HEAD as default branch rather than master
- Loading branch information
Showing
5 changed files
with
55 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# 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](#functionality) | ||
* [Install](#install) | ||
* [Run and Configure](#run-and-configure) | ||
* [Known Issues/Bugs](#known-issuesbugs) | ||
* [Backlog](#backlog) | ||
* [How to Debug](#how-to-debug) | ||
|
||
# Functionality | ||
|
||
Load up a Markdown file and get highlights and hovers for existing issues. Checking will occur as you type in the document. | ||
|
||
![Underscores and hovers](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo1.gif) | ||
|
||
The status bar lets you quickly navigate to any issue and you can see all positions in the gutter. | ||
|
||
[![Jump to issues](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo2.gif)](http://shouldnottouchthis/) | ||
[![Jump to issues](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo2.gif)](https://github.com/username/repository/blob/HEAD/monkey) | ||
![](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo2.gif) | ||
<img src="https://github.com/username/repository/raw/HEAD/images/myImage.gif"> | ||
|
||
The `spellMD.json` config file is watched so you can add more ignores or change mappings at will. | ||
|
||
![Add to dictionary](https://github.com/username/repository/raw/HEAD/images/SpellMDDemo3.gif) | ||
|
||
![issue](https://github.com/username/repository/raw/HEAD/issue) | ||
|
||
[mono](https://github.com/username/repository/blob/HEAD/monkey) | ||
[not](http://shouldnottouchthis/) | ||
[Email me](mailto:[email protected]) | ||
|
||
# Install | ||
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`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,7 +19,7 @@ Load up a Markdown file and get highlights and hovers for existing issues. Chec | |
The status bar lets you quickly navigate to any issue and you can see all positions in the gutter. | ||
|
||
[![Jump to issues](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif)](http://shouldnottouchthis/) | ||
[![Jump to issues](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif)](https://github.com/username/repository/blob/master/monkey) | ||
[![Jump to issues](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif)](https://github.com/username/repository/blob/HEAD/monkey) | ||
![](https://github.com/username/repository/path/to/images/SpellMDDemo2.gif) | ||
<img src="https://github.com/username/repository/path/to/images/myImage.gif"> | ||
|
||
|
@@ -29,7 +29,7 @@ The `spellMD.json` config file is watched so you can add more ignores or change | |
|
||
![issue](https://github.com/username/repository/path/to/issue) | ||
|
||
[mono](https://github.com/username/repository/blob/master/monkey) | ||
[mono](https://github.com/username/repository/blob/HEAD/monkey) | ||
[not](http://shouldnottouchthis/) | ||
[Email me](mailto:[email protected]) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters