Skip to content

Commit 0f51ee4

Browse files
committed
ci: add rumdl
1 parent d4d6024 commit 0f51ee4

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed

.github/workflows/rumdl-lint.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Markdown linting via rumdl
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "**/*.md"
8+
- ".github/workflows/rumdl-lint.yml"
9+
- ".rumdl.toml"
10+
pull_request:
11+
paths:
12+
- "**/*.md"
13+
14+
jobs:
15+
rumdl:
16+
name: rumdl
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v6
20+
- uses: rvben/rumdl@v0
21+
with:
22+
report-type: annotations

.rumdl.toml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# DOCS https://github.com/rvben/rumdl/blob/main/docs/global-settings.md
2+
3+
[global]
4+
line-length = 80
5+
disable = ["blanks-around-lists"] # rule of proximity
6+
7+
# ------------------------------------------------------------------------------
8+
9+
[ul-style]
10+
style = "dash" # GitHub default & quicker to type
11+
12+
[ul-indent]
13+
indent = 4 # consistent with .editorconfig
14+
15+
[line-length]
16+
code-blocks = false
17+
reflow = true # enable auto-formatting
18+
19+
[blanks-around-headings]
20+
lines-below = 0 # rule of proximity
21+
22+
[ol-prefix]
23+
style = "ordered"
24+
25+
[no-inline-html]
26+
allowed-elements = ["a", "img", "kbd"] # badges
27+
28+
[emphasis-style]
29+
style = "asterisk" # better than underscore, since not considered a word-char
30+
31+
[strong-style]
32+
style = "asterisk"
33+
34+
[table-format]
35+
enabled = true # opt-in rule
36+
37+
[heading-capitalization]
38+
enabled = true # opt-in rule
39+
style = "sentence_case"
40+
ignore-words = ["nvim", "Obsidian", "Alfred"]
41+
42+
# ------------------------------------------------------------------------------
43+
44+
[per-file-ignores]
45+
".github/pull_request_template.md" = ["first-line-h1"]

0 commit comments

Comments
 (0)