Skip to content

Commit 6b2a0df

Browse files
committed
docs(ci): document the MegaLinter integration
1 parent 4140e5c commit 6b2a0df

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

docs/usage/ci-cd.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,21 @@ steps:
130130
displayName: Lint Markdown
131131
```
132132

133+
## MegaLinter
134+
135+
rumdl ships out of the box in [MegaLinter](https://megalinter.io/), a linters
136+
aggregator for CI. MegaLinter's Markdown descriptor defaults to markdownlint, so
137+
selecting rumdl takes two settings:
138+
139+
```yaml title=".mega-linter.yml"
140+
MARKDOWN_DEFAULT_STYLE: rumdl
141+
ENABLE_LINTERS:
142+
- MARKDOWN_RUMDL
143+
```
144+
145+
See MegaLinter's [rumdl page](https://megalinter.io/latest/descriptors/markdown_rumdl/)
146+
for the rest of its options, including `APPLY_FIXES` for autofixes.
147+
133148
## Exit Codes
134149

135150
rumdl uses standard exit codes for CI:

0 commit comments

Comments
 (0)