Skip to content

Commit

Permalink
Create workflow to lint Markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
MGaetan89 committed Jul 2, 2024
1 parent 3d89fd2 commit a998ce8
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/lint-markdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: "Lint Markdown"

on:
merge_group:
pull_request:
push:
branches: [ master ]

jobs:
lint_project:
name: "Lint Markdown"
runs-on: ubuntu-latest
permissions:
statuses: write
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Lint Markdown
uses: DavidAnson/markdownlint-cli2-action@v16
with:
config: ".markdownlint.jsonc"
globs: "docs/**/*.md"
8 changes: 8 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc
{
"MD013": {
"line_length": 120,
"heading_line_length": 120,
"code_block_line_length": 120
}
}

0 comments on commit a998ce8

Please sign in to comment.