Skip to content

Commit

Permalink
ci(markdownlint): add Markdown linting (#838)
Browse files Browse the repository at this point in the history
  • Loading branch information
jlemesh committed Oct 18, 2024
1 parent aee31ce commit d4df666
Show file tree
Hide file tree
Showing 6 changed files with 536 additions and 505 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -193,3 +193,17 @@ jobs:
run: |
pip install yamllint
./run-tests.sh --check-yamllint
lint-markdownlint:
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node
uses: actions/setup-node@v4

- name: Lint Markdown files
run: |
npm install markdownlint-cli2 --global
./run-tests.sh --check-markdownlint
11 changes: 11 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
MD013: false

# MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md037.md
MD037: false

# MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md041.md
MD041: false

# MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md043.md
MD043: false
Loading

0 comments on commit d4df666

Please sign in to comment.