Add markdown linting to CI

This commit is contained in:
Niels van Velzen 2022-09-06 22:03:39 +02:00 committed by Max Rumpf
parent 7a639f8138
commit de10e5efc8
2 changed files with 26 additions and 0 deletions

View File

@ -8,6 +8,16 @@ on:
workflow_dispatch:
jobs:
lint:
runs-on: ubuntu-20.04
steps:
- name: Checkout repository
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
- name: Setup problem matcher
uses: xt0rted/markdownlint-problem-matcher@v1.1.0
- name: Run markdownlint
run: npx --package markdownlint-cli markdownlint readme.md docs/**/*.md --ignore node_modules
build-vitepress:
runs-on: ubuntu-20.04
steps:

16
.markdownlint.yaml Normal file
View File

@ -0,0 +1,16 @@
# MD010/hard-tabs
MD010:
code_blocks: false
# MD013/line-length
MD013:
line_length: 120
# MD028/no-blanks-blockquote
MD028: false
# MD033/no-inline-html
MD033:
allowed_elements:
- details
- summary