Skip to content

Commit

Permalink
Add markdown linter and update rules (#451)
Browse files Browse the repository at this point in the history
* add markdown.yaml
* Update rules
  • Loading branch information
evilnick authored May 30, 2024
1 parent 55c01ca commit c83bc1a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 3 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/markdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: "Docs: Markdown lint"

on: [push, pull_request]

jobs:
markdown-lint:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: tj-actions/changed-files@v44
id: changed-files
- uses: DavidAnson/markdownlint-cli2-action@v16
if: steps.changed-files.outputs.any_changed == 'true'
with:
config: 'docs/src/.markdownlint.json'
globs: ${{ steps.changed-files.outputs.all_changed_files }}
separator: ","


16 changes: 13 additions & 3 deletions docs/src/.markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
{
"default": true,
"default": false,
"MD003": { "style": "atx" },
"MD040": false,
"MD053": false
"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 c83bc1a

Please sign in to comment.