SublimeLinter-contrib-markdownlint
A Sublime Text Linter for Markdown/CommonMark files.
Details
Installs
- Total 5K
- Win 2K
- Mac 2K
- Linux 1K
Jun 3 | Jun 2 | Jun 1 | May 31 | May 30 | May 29 | May 28 | May 27 | May 26 | May 25 | May 24 | May 23 | May 22 | May 21 | May 20 | May 19 | May 18 | May 17 | May 16 | May 15 | May 14 | May 13 | May 12 | May 11 | May 10 | May 9 | May 8 | May 7 | May 6 | May 5 | May 4 | May 3 | May 2 | May 1 | Apr 30 | Apr 29 | Apr 28 | Apr 27 | Apr 26 | Apr 25 | Apr 24 | Apr 23 | Apr 22 | Apr 21 | Apr 20 | Apr 19 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 1 | 0 | 4 | 0 | 0 | 0 | 2 | 4 | 0 | 0 | 4 | 0 | 0 | 0 | 2 | 1 | 1 | 0 | 4 | 1 | 0 | 0 | 1 | 0 | 2 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 2 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 1 | 0 | 2 |
Mac | 0 | 1 | 0 | 1 | 1 | 0 | 0 | 2 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 2 | 0 | 0 | 4 | 0 | 1 | 1 | 1 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 2 | 5 |
Linux | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 1 | 0 | 1 | 1 | 0 | 0 | 0 | 2 | 0 | 0 | 3 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 |
Readme
- Source
- raw.githubusercontent.com
Sublime Text Markdownlint
A Sublime Text plug-in for linting Markdown/CommonMark files.
Installing
SublimeLinter must be installed in order to use this plug-in. If SublimeLinter is not installed, please follow the instructions outlined here.
Install Markdownlint
Before using this plug-in, you must ensure that markdownlint is
installed on your system. To install markdownlint
, do the following:
- Install Node.js.
- Install
markdownlint
by typing the following in a terminal:
npm install -g markdownlint-cli
- If you are using
nvm
andzsh
, ensure that the line to loadnvm
is in.zshenv
and not.zshrc
. - If you are using
zsh
andoh-my-zsh
, do not load thenvm
plug-in foroh-my-zsh
.
Install Sublime Text Markdownlint
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 seePackage 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 seeSublimeLinter-contrib-markdownlint
. If that entry is not highlighted, use the keyboard or mouse to select it.
Markdownlint Configuration Files
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"]
}
}
}
Contributing
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plug-in repository.
- Hack on a separate topic branch created from the latest
master
. - Commit and push the topic branch.
- Make a pull request.
- Be patient.
Please note that modifications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don't be afraid to use it.
- Please use descriptive variable names, no abbreviations unless they are very well known.
Author
Jon LaBelle