Skip to content

Commit 19e2435

Browse files
committed
Switch Markdown linter to node based markdownlint-cli.
I've prefered the node based linter to the ruby one, but it didn't have a CLI until recently. Also the config file is in an easier format.
1 parent 5ebcb5d commit 19e2435

File tree

4 files changed

+19
-16
lines changed

4 files changed

+19
-16
lines changed

.markdownlintrc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
// Enable all markdownlint rules
3+
"default": true,
4+
5+
// Disable line length check for tables and code blocks
6+
"MD013": { "line_length": 80, "code_blocks": false, "tables": false },
7+
8+
// Set Ordered list item prefix to "ordered" (use 1. 2. 3. not 1. 1. 1.)
9+
"MD029": { "style": "ordered" },
10+
11+
// Set list indent level to 4 which Python-Markdown requires
12+
"MD007": { "indent": 4 },
13+
14+
// Exclude code block style
15+
"MD046": false
16+
}

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ matrix:
77
# Default Python
88
- env: TOXENV=flake8
99
- env: TOXENV=markdown-lint
10-
before_install: gem install mdl
10+
before_install: npm install -g markdownlint-cli
1111
- env: TOXENV=linkchecker
1212
- env: TOXENV=jshint
1313
before_install: npm install -g jshint

mdl_ruleset.rb

Lines changed: 0 additions & 13 deletions
This file was deleted.

tox.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ deps=-rrequirements/test.txt
2121
commands={envbindir}/flake8 mkdocs --max-line-length=119 --exclude=mkdocs/compat.py
2222

2323
[testenv:markdown-lint]
24-
whitelist_externals = mdl
24+
whitelist_externals = markdownlint
2525
passenv = *
26-
commands=mdl --style mdl_ruleset.rb README.md CONTRIBUTING.md docs/
26+
commands=markdownlint README.md CONTRIBUTING.md docs/
2727

2828
[testenv:linkchecker]
2929
basepython = python2.7

0 commit comments

Comments
 (0)