A Sublime Text Linter for Markdown/CommonMark files.
MIT License
A Sublime Text plug-in for linting Markdown/CommonMark files.
SublimeLinter must be installed in order to use this plug-in. If SublimeLinter is not installed, please follow the instructions outlined here.
Before using this plug-in, you must ensure that markdownlint is
installed on your system. To install markdownlint
, do the following:
markdownlint
by typing the following in a terminal: npm install -g markdownlint-cli
nvm
and zsh
, ensure that the line to load nvm
is in.zshenv
and not .zshrc
.zsh
and oh-my-zsh
, do not load the nvm
plug-in foroh-my-zsh
.Please use Package Control to install Sublime Text Markdownlint. This will ensure that the plug-in will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won't cover that here.
To install via Package Control, do the following:
Within Sublime Text, bring up the Command Palette and type install
.
Among the commands you should see Package Control: Install Package
. If that
command is not highlighted, use the keyboard or mouse to select it. There
will be a pause of a few seconds while Package Control fetches the list of
available plug-ins.
When the plug-in list appears, type markdownlint
. Among the entries you
should see SublimeLinter-contrib-markdownlint
. If that entry is not
highlighted, use the keyboard or mouse to select it.
Markdownlint configuration files (.markdownlintrc
) are resolved first by
checking the source directory of file being linted, then by checking the user
$HOME
path.
To specify a custom Markdownlint configuration path, create a markdownlint
section under linters in your SublimeLinter User Settings
(SublimeLinter.sublime-settings
). Then add an args
key with the appropriate
path to your --config
file. For example:
{
"linters": {
"markdownlint": {
"args": ["--config", "/custom/path/to/.markdownlintrc"]
}
}
}
If you would like to contribute enhancements or fixes, please do the following:
master
.Please note that modifications should follow these coding guidelines:
Jon LaBelle