From 3a6943843b32cf007a3f71c2f7e1b19b4dea3087 Mon Sep 17 00:00:00 2001 From: Kevin Deldycke Date: Mon, 3 Aug 2020 14:37:12 +0200 Subject: [PATCH] Lint markdown in addition to awesome list. --- .github/markdown-lint.yaml | 13 +++++++++++++ .github/workflows/lint.yaml | 20 +++++++++++++++----- 2 files changed, 28 insertions(+), 5 deletions(-) create mode 100644 .github/markdown-lint.yaml diff --git a/.github/markdown-lint.yaml b/.github/markdown-lint.yaml new file mode 100644 index 0000000..6607783 --- /dev/null +++ b/.github/markdown-lint.yaml @@ -0,0 +1,13 @@ +# See example at: https://github.com/avto-dev/markdown-lint/blob/master/lint/config/changelog.yml + +# Line length +# XXX Temporary disabled because of line continuation edge-case. See: +# https://github.com/DavidAnson/markdownlint/issues/302 +MD013: false + +# Inline HTML +# is allowed for beautiful rendering on GitHub. +MD033: + # Whitelist some elements for beautiful rendering on GitHub. + allowed_elements: + - 'img' diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index ab437c5..897fa0d 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -1,4 +1,4 @@ -name: Lint Awesome List +name: Lint on: push: pull_request: @@ -8,12 +8,22 @@ on: jobs: - lint: - name: Lint + lint-markdown: + name: Lint markdown runs-on: ubuntu-latest steps: - - uses: actions/checkout@master + - uses: actions/checkout@v2.3.1 + - uses: avto-dev/markdown-lint@v1.3.1 + with: + config: '.github/markdown-lint.yaml' + args: './**/*.md' + + lint-awesome: + name: Lint Awesome list + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2.3.1 with: # Fetch all history to please linter's age checks. fetch-depth: 0 - - uses: max/awesome-lint@master + - uses: max/awesome-lint@v2.0.0