Skip to content

Commit

Permalink
Add GitHub action for linting markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
k-dimple committed Oct 14, 2024
1 parent 0fadd8f commit fb2f6ec
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
15 changes: 15 additions & 0 deletions sp-files/.github/workflows/markdown-style-checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: "Linter for Markdown"

on: [push, pull_request]

jobs:
markdown-lint:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: DavidAnson/markdownlint-cli2-action@v16
with:
config: ".markdownlint.json"

16 changes: 16 additions & 0 deletions sp-files/.markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"default": false,
"MD003": { "style": "atx" },
"MD013": { "code_blocks": false, "tables": false, "stern": true, "line_length": 80},
"MD014": true,
"MD018": true,
"MD022": true,
"MD023": true,
"MD026": { "punctuation": ".,;。,;"},
"MD031": { "list_items": false},
"MD032": true,
"MD035": true,
"MD042": true,
"MD045": true,
"MD052": true
}

0 comments on commit fb2f6ec

Please sign in to comment.