Skip to content

Commit a03d106

Browse files
committed
feat: add GitHub Actions workflows for link checking and markdown linting
1 parent b7bfd49 commit a03d106

3 files changed

Lines changed: 69 additions & 0 deletions

File tree

.github/workflows/link-checker.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Link Checker
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- "**.md"
8+
pull_request:
9+
branches: [master]
10+
paths:
11+
- "**.md"
12+
workflow_dispatch:
13+
14+
jobs:
15+
check-links:
16+
name: Check Markdown Links
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- uses: actions/checkout@v6
21+
22+
- name: Markdown Link Check
23+
uses: gaurav-nelson/github-action-markdown-link-check@v1
24+
with:
25+
use-quiet-mode: "yes"
26+
use-verbose-mode: "yes"
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Markdown Lint
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- "**.md"
8+
pull_request:
9+
branches: [master]
10+
paths:
11+
- "**.md"
12+
workflow_dispatch:
13+
14+
jobs:
15+
lint:
16+
name: Lint Markdown Files
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- uses: actions/checkout@v6
21+
22+
- name: Markdown Lint
23+
uses: DavidAnson/markdownlint-cli2-action@v19
24+
with:
25+
globs: |
26+
**/*.md

.markdownlint.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# markdownlint configuration
2+
# https://github.com/DavidAnson/markdownlint
3+
default: true
4+
5+
# Allow long lines (common in README tables, links, etc.)
6+
MD013: false
7+
8+
# Allow duplicate headings in different sections
9+
MD024:
10+
siblings_only: true
11+
12+
# Allow inline HTML (useful for badges, images, etc.)
13+
MD033:
14+
allowed_elements: [img, a, br, hr, details, summary, b, td, table, tr, th]
15+
16+
# Allow bare URLs
17+
MD034: false

0 commit comments

Comments
 (0)