Skip to content

Commit

Permalink
Markdown linter
Browse files Browse the repository at this point in the history
  • Loading branch information
rhagelstrom committed Feb 7, 2024
1 parent 52f17df commit 1b6e9ed
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
6 changes: 6 additions & 0 deletions .github/configs/markdown_lint_rules.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"MD013": false,
"MD033": {
"allowed_elements": ["div"]
}
}
21 changes: 21 additions & 0 deletions .github/workflows/markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
on:
push:
paths:
- 'README.md'

name: Lint README.md
jobs:

lint-readme:
name: Lint README.md file
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v4

- name: Lint README.md file
uses: avto-dev/markdown-lint@v1.5.0
with:
config: '.github/configs/markdown_lint_rules.json'
args: 'README.md'

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Contaminated

[![Build FG Extension](https://github.com/rhagelstrom/Contaminated/actions/workflows/create-release.yml/badge.svg)](https://github.com/rhagelstrom/Contaminated/actions/workflows/create-release.yml) [![Luacheckrc](https://github.com/rhagelstrom/Contaminated/actions/workflows/luacheck.yml/badge.svg)](https://github.com/rhagelstrom/Contaminated/actions/workflows/luacheck.yml)
[![Build FG Extension](https://github.com/rhagelstrom/Contaminated/actions/workflows/create-release.yml/badge.svg)](https://github.com/rhagelstrom/Contaminated/actions/workflows/create-release.yml) [![Luacheckrc](https://github.com/rhagelstrom/Contaminated/actions/workflows/luacheck.yml/badge.svg)](https://github.com/rhagelstrom/Contaminated/actions/workflows/luacheck.yml) [![Markdownlint](https://github.com/rhagelstrom/Contaminated/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/rhagelstrom/Contaminated/actions/workflows/markdownlint.yml)

**Current Version:** 1.3
**Last Updated:** 01/21/23
Expand Down

0 comments on commit 1b6e9ed

Please sign in to comment.