Skip to content

Commit a319c6a

Browse files
committed
Add markdown linting to workflows
1 parent 1f21050 commit a319c6a

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

.github/workflows/lint-docs.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "Lint documentation"
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches: [ main, linux ]
7+
pull_request:
8+
branches: [ main, linux ]
9+
10+
jobs:
11+
lint-markdown:
12+
name: Lint markdown files
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
16+
17+
- uses: DavidAnson/markdownlint-cli2-action@744f913a124058ee903768d3adb92a4847e5d132
18+
with:
19+
globs: "**/*.md"

.markdownlint.jsonc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// For information on writing markdownlint configuration see:
2+
// https://github.com/DavidAnson/markdownlint/blob/main/README.md#optionsconfig
3+
{
4+
"MD013": false, // Line length and line breaking convention not yet standardised across docs
5+
"MD024": false // The format for some files require repeated headings, e.g. "Example"
6+
}

0 commit comments

Comments
 (0)