Skip to content

Commit dfbab67

Browse files
committed
Implement markdown linter
1 parent 443772a commit dfbab67

2 files changed

Lines changed: 84 additions & 1 deletion

File tree

.gitlab-ci.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,20 @@ build:
3131

3232
lint-links:
3333
stage: lint
34-
image: ghcr.io/code0-tech/build-images/telescopium-lint:271.1
34+
image: ghcr.io/code0-tech/build-images/telescopium-lint:291.1
3535
needs: []
3636
script:
3737
- ./clone_projects.sh
3838
- lychee --offline --no-progress --include-fragments --no-ignore content
3939

40+
lint-markdown:
41+
stage: lint
42+
image: ghcr.io/code0-tech/build-images/telescopium-lint:291.1
43+
needs: []
44+
script:
45+
- ./clone_projects.sh
46+
- rumdl check --fail-on any
47+
4048
pages:
4149
extends:
4250
- .build

rumdl.toml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
[global]
2+
include = [
3+
"content/**/*.md",
4+
"content/**/*.mdx",
5+
]
6+
7+
# content repositories are gitignored because they are cloned in the pipeline
8+
respect-gitignore = false
9+
10+
extend-disable = [
11+
# we have lychee for link checking
12+
"MD051",
13+
"MD052",
14+
]
15+
16+
[per-file-flavor]
17+
"**/*.md" = "standard"
18+
"**/*.mdx" = "mdx"
19+
20+
[MD003] # heading-style
21+
style = "atx"
22+
23+
[MD004] # ul-style
24+
style = "dash"
25+
26+
[MD013] # line-length
27+
line-length = 120
28+
29+
[MD029] # ol-prefix
30+
style = "one-or-ordered"
31+
32+
[MD032] # blanks-around-lists
33+
allow-lazy-continuation = false
34+
35+
[MD040] # fenced-code-language
36+
style = "consistent"
37+
unknown-language-action = "error"
38+
39+
[MD044] # proper-names
40+
names = [
41+
# none yet
42+
]
43+
44+
[MD046] # code-block-style
45+
style = "fenced"
46+
47+
[MD048] # code-fence-style
48+
style = "backtick"
49+
50+
[MD049] # emphasis-style
51+
style = "asterisk"
52+
53+
[MD050] # strong-style
54+
style = "asterisk"
55+
56+
[MD054] # link-image-style
57+
autolink = true
58+
inline = true
59+
full = false
60+
collapsed = false
61+
shortcut = false
62+
url-inline = false # prefer autolink
63+
64+
[MD055] # table-pipe-style
65+
style = "leading-and-trailing"
66+
67+
[MD057] # existing-relative-links
68+
absolute-links = "warn"
69+
70+
[MD070] # nested-code-fence
71+
enabled = true
72+
73+
[MD072] # frontmatter-key-sort
74+
enabled = true
75+
key-order = ["title", "description"]

0 commit comments

Comments
 (0)