From c653cf5df878ea4cb48cf951638179b6838b9cea Mon Sep 17 00:00:00 2001 From: Thomas Nieto <38873752+ThomasNieto@users.noreply.github.com> Date: Tue, 27 Aug 2024 16:51:40 -0500 Subject: [PATCH] Add lint markdown --- .github/workflows/lint.yml | 17 ++++++++++++ .markdownlint.jsonc | 54 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) create mode 100644 .github/workflows/lint.yml create mode 100644 .markdownlint.jsonc diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..5c2050e --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,17 @@ +name: Lint + +on: + pull_request: + + push: + +jobs: + markdown: + name: Markdown + runs-on: ubuntu-latest + steps: + - name: "Checkout repository" + uses: "actions/checkout@v4" + + - name: "Lint markdown" + uses: DavidAnson/markdownlint-cli2-action@v16 diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 0000000..853ed89 --- /dev/null +++ b/.markdownlint.jsonc @@ -0,0 +1,54 @@ +{ + "code-block-style": { + "style": "fenced" + }, + "code-fence-style": { + "style": "backtick" + }, + "emphasis-style": { + "style": "asterisk" + }, + "fenced-code-language": { + "allowed_languages": [ + "powershell", + "text" + ], + "language_only": true + }, + "heading-style": { + "style": "atx" + }, + "hr-style": { + "style": "---" + }, + "line-length": { + "strict": true, + "code_blocks": false + }, + "link-image-style": { + "collapsed": false, + "url_inline": false + }, + "no-duplicate-heading": { + "siblings_only": true + }, + "ol-prefix": { + "style": "ordered" + }, + "proper-names": { + "code_blocks": false, + "names": [ + "PowerShell", + "AnyPackage" + ] + }, + "reference-links-images": { + "shortcut_syntax": true + }, + "strong-style": { + "style": "asterisk" + }, + "ul-style": { + "style": "dash" + } +}