Skip to content

Commit 2201802

Browse files
authored
Add the markdownlint tool (#265)
Add the tool so we can begin working on the lint issues. Signed-off-by: Dean Roehrich <dean.roehrich@hpe.com>
1 parent d08e0b6 commit 2201802

2 files changed

Lines changed: 37 additions & 0 deletions

File tree

.markdownlint.jsonc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
// Default state for all rules
3+
"default": true,
4+
5+
// MD007/ul-indent Unordered list indentation
6+
"MD007": {
7+
// Spaces for indent
8+
"indent": 4
9+
},
10+
11+
// MD013/line-length - Line length
12+
"MD013": {
13+
// Number of characters
14+
"line_length": 900,
15+
// Number of characters for headings
16+
"heading_line_length": 80,
17+
// Number of characters for code blocks
18+
"code_block_line_length": 500 // some example console output is wide
19+
},
20+
21+
// MD046/code-block-style - Code block style
22+
// Disable consistency checks between fenced/indented code blocks.
23+
// Standard code blocks should use fences, while mkdocs admonitions require
24+
// 4-space indented blocks.
25+
"code-block-style": false
26+
}
27+

Makefile

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Runs a container that lints all markdown (.md) files in the project.
2+
# Uses the markdownlint-cli (https://github.com/igorshubovych/markdownlint-cli).
3+
# Rules for markdownlint package can be found here:
4+
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
5+
markdownlint:
6+
docker run --rm --name markdownlint \
7+
--volume ${PWD}:/workdir \
8+
ghcr.io/igorshubovych/markdownlint-cli:latest \
9+
--config .markdownlint.jsonc --ignore venv "**/*.md"
10+

0 commit comments

Comments
 (0)