Skip to content

Commit 1f70dec

Browse files
committed
Replace mdl with markdownlint
`markdownlint` is based on `mdl`, has a broader set of rules and is implemented with NodeJS instead of Ruby which makes it easier to install `markdownlint` as a pre-commit hook.
1 parent 7b0e55e commit 1f70dec

4 files changed

+26
-7
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
!.editorconfig
33
!.gitignore
44
!.gitlab-ci.yml
5-
!.mdl_style.rb
5+
!.markdownlint.yaml
66
!.pre-commit-config.yaml
77
*.pyc
88
__pycache__/

.gitlab-ci.yml

-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ pre-commit:
88
stage: check
99
image: python:3
1010
before_script:
11-
- apt-get update
12-
- apt-get install -y --no-install-recommends ruby
13-
- gem install chef-utils -v 16.6.14
1411
- pip install pre-commit
1512
script:
1613
- pre-commit run --all-files || {

.markdownlint.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Default state for all rules
2+
default: true
3+
4+
# MD013/line-length - Line length
5+
MD013:
6+
# Number of characters
7+
line_length: 120
8+
# Number of characters for headings
9+
heading_line_length: 120
10+
# Number of characters for code blocks
11+
code_block_line_length: 120
12+
# Include code blocks
13+
code_blocks: true
14+
# Include tables
15+
tables: true
16+
# Include headings
17+
headings: true
18+
# Include headings
19+
headers: true
20+
# Strict length checking
21+
strict: false
22+
# Stern length checking
23+
stern: true

.pre-commit-config.yaml

+2-3
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,10 @@ repos:
4242
'--ignore=body-is-missing,title-must-not-contain-word',
4343
'--msg-filename'
4444
]
45-
- repo: https://github.com/markdownlint/markdownlint
46-
rev: v0.11.0
45+
- repo: https://github.com/igorshubovych/markdownlint-cli
46+
rev: v0.27.1
4747
hooks:
4848
- id: markdownlint
49-
args: ['--style=.mdl_style.rb']
5049
- repo: https://github.com/adrienverge/yamllint
5150
rev: v1.26.1
5251
hooks:

0 commit comments

Comments
 (0)