ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-contrib-markdownlint

by jonlabelle ST3

A Sublime Text Linter for Markdown/CommonMark files.

Details

Installs

  • Total 628
  • Win 231
  • OS X 251
  • Linux 146
Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7 Apr 6 Apr 5 Apr 4 Apr 3 Apr 2 Apr 1 Mar 31 Mar 30 Mar 29 Mar 28 Mar 27 Mar 26 Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10
Windows 1 1 0 1 2 2 4 2 4 3 1 2 1 0 3 1 1 0 0 1 1 3 1 1 0 1 0 2 1 1 0 0 1 2 0 1 1 0 0 0 3 1 1 1 0 0
OS X 1 1 2 4 0 0 1 0 1 2 0 2 3 2 2 2 2 0 2 1 3 2 2 1 0 0 1 1 1 2 1 4 1 0 2 2 4 2 2 1 2 4 3 0 1 1
Linux 1 1 1 0 2 1 1 0 0 0 0 1 1 0 1 0 2 0 6 1 3 0 0 0 0 2 1 1 1 1 0 0 2 0 3 2 1 0 1 1 1 2 2 2 0 0

Readme

Source
raw.​githubusercontent.​com

Sublime Text Markdownlint

Travis Build Status Package Control Installs Latest Version

A Sublime Text plug-in for linting Markdown/CommonMark files.

Markdownlint Screenshot

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:

  1. Install Node.js.
  2. Install markdownlint by typing the following in a terminal:
npm install -g markdownlint-cli
  1. If you are using nvm and zsh, ensure that the line to load nvm is in .zshenv and not .zshrc.
  2. If you are using zsh and oh-my-zsh, do not load the nvm plug-in for oh-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:

  1. 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.

  2. 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

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:

  1. Fork the plug-in repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. 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

License

MIT License