https://github.com/leonelgalan/linter-markdownlint

Atom Linter for markdown using markdownlint/mdl
https://github.com/leonelgalan/linter-markdownlint

atom linter linter-markdownlint linter-plugin markdownlint mdl

Last synced: 21 days ago
JSON representation

Atom Linter for markdown using markdownlint/mdl

• Host: GitHub
• URL: https://github.com/leonelgalan/linter-markdownlint
• Owner: leonelgalan
• Created: 2015-08-14T09:23:18.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-02-12T10:19:26.000Z (almost 3 years ago)
• Last Synced: 2024-10-27T18:11:10.132Z (3 months ago)
• Topics: atom, linter, linter-markdownlint, linter-plugin, markdownlint, mdl
• Language: JavaScript
• Homepage: https://atom.io/packages/linter-markdownlint
• Size: 79.1 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# linter-markdownlint

This linter plugin for [Linter](https://github.com/AtomLinter/Linter) provides an interface to [markdownlint](https://github.com/mivok/markdownlint). It will be used with files that have the "Markdown" syntax.

## Installation

Linter package must be installed in order to use this plugin. If Linter is not installed, please follow the instructions [here](https://github.com/AtomLinter/Linter).

### mdl installation

Before using this plugin, you must ensure that `mdl` is installed on your system. To install `mdl`, do the following:

1. Install [ruby](https://www.ruby-lang.org/).

1. Install [markdownlint](https://github.com/mivok/markdownlint) by typing the following in a terminal:

```sh

gem install mdl

```

Now you can proceed to install the _linter-markdownlint_ plugin.

### Plugin installation

```sh

apm install linter-markdownlint

```

## Settings

You can configure _linter-markdownlint_ by editing ~/.atom/config.cson (choose _Config..._ in _Atom_ menu):

```cson

'linter-markdownlint':

  executablePath: 'mdl'

  severity: 'error'

```

Run `which mdl` to find the path, if you using _rbenv_ run `rbenv which mdl`