From 6c25c28801c094c98ff0bbf11b90f9bd5eabf42b Mon Sep 17 00:00:00 2001 From: Christopher Fenner <26137398+CCFenner@users.noreply.github.com> Date: Mon, 15 Jun 2020 21:10:12 +0200 Subject: [PATCH] chore(pipeline): add action to lint markdown files (#1593) * add markdownlint action * add markdownlint config * add dummy change to MD file * rename job * run on master branch * remove ignore files * add dummy change * revert dummy change * Update markdown.yml * Update .markdownlint.yml * Update README.md * Update .markdownlint.yml * Update markdown.yml --- .github/workflows/markdown.yml | 22 ++++++++++++++++++++++ .markdownlint.yml | 24 ++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 .github/workflows/markdown.yml create mode 100644 .markdownlint.yml diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml new file mode 100644 index 000000000..787ae814e --- /dev/null +++ b/.github/workflows/markdown.yml @@ -0,0 +1,22 @@ +name: "Documentation" + +on: + push: + branches: + - master + pull_request: + branches: + - master + paths: + - '**/*.md' + +jobs: + markdownlint: + runs-on: ubuntu-latest + name: 'Format' + steps: + - uses: actions/checkout@v2 + - name: Markdown Linting + uses: nosborn/github-action-markdown-cli@v1.1.1 + with: + files: . diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 000000000..112e23885 --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,24 @@ +default: true + +# ignore +MD013: false #line-length +MD033: false #no-inline-html + +# TODO: fix in separate PR +MD001: false #heading-increment/header-increment +MD004: false #ul-style +MD012: false #no-multiple-blanks +MD007: false #ul-indent +MD022: false #blanks-around-headings/blanks-around-headers +MD024: false #no-duplicate-heading/no-duplicate-header +MD026: false #no-trailing-punctuation +MD030: false #list-marker-space +MD031: false #blanks-around-fences +MD032: false #blanks-around-lists +MD036: false #no-emphasis-as-heading/no-emphasis-as-header +MD038: false #no-space-in-code +MD039: false #no-space-in-links +MD040: false #fenced-code-language +MD042: false #no-empty-links +MD041: false #first-line-heading/first-line-h1 +MD046: false #code-block-style