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 348
  • Win 136
  • OS X 134
  • Linux 78
Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8
Windows 0 0 0 0 4 1 2 2 0 2 1 1 1 4 0 1 0 5 0 2 1 0 1 0 0 1 2 0 2 0 0 0 0 1 1 3 0 0 0 1 0 0 2 1 2 1
OS X 0 1 0 3 2 0 0 1 0 0 0 1 0 1 3 2 1 0 3 1 0 2 1 2 0 1 2 2 0 0 2 0 2 1 2 1 1 0 0 0 1 2 1 1 0 1
Linux 0 1 0 4 1 2 2 2 0 3 1 1 0 1 0 1 0 0 0 0 0 0 0 0 0 0 3 1 1 0 3 1 1 0 2 1 0 1 1 2 1 2 1 0 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 3 must be installed in order to use this plug-in. If SublimeLinter 3 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.

Markdownlint Configuration

In order for markdownlint to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once you have installed and configured markdownlint, you can proceed to install the SublimeLinter-contrib-markdownlint plug-in if it is not yet installed.

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.

Sublime Text Markdownlint Configuration

Configuring the plug-in is done through linter settings.

To ensure markdownlint configuration is accessible to the plug-in, use chdir setting to ensure markdownlint is executed relative to your configuration file.

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