diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml new file mode 100644 index 000000000..9fdc84c09 --- /dev/null +++ b/.github/workflows/markdownlint.yml @@ -0,0 +1,13 @@ +name: Lint markdown +on: + workflow_dispatch: + pull_request: +jobs: + lint: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v5 + - name: Run Markdown linter + uses: DavidAnson/markdownlint-cli2-action@v20 + continue-on-error: false diff --git a/.github/workflows/super-linter.yml b/.github/workflows/super-linter.yml deleted file mode 100644 index 7fcf73349..000000000 --- a/.github/workflows/super-linter.yml +++ /dev/null @@ -1,41 +0,0 @@ -name: Super Linter - -on: - workflow_dispatch: - -permissions: - contents: read # to fetch code (actions/checkout) - -jobs: - build: - permissions: - contents: read # to fetch code (actions/checkout) - statuses: write # to mark status of each linter run (github/super-linter/slim) - - name: Lint Code Base - runs-on: ubuntu-latest - if: ${{ github.actor != 'dependabot[bot]' }} - - steps: - - name: Checkout Code - uses: actions/checkout@v5 - - - name: Lint Code Base - uses: super-linter/super-linter/slim@v6 - env: - DEFAULT_BRANCH: master - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - IGNORE_GITIGNORED_FILES: true - LINTER_RULES_PATH: / - LOG_LEVEL: NOTICE - MARKDOWN_CONFIG_FILE: .markdownlint.yaml - SUPPRESS_POSSUM: true - VALIDATE_CSS: false - VALIDATE_EDITORCONFIG: false - VALIDATE_GITLEAKS: false - VALIDATE_HTML: false - VALIDATE_JAVASCRIPT_STANDARD: false - VALIDATE_JSCPD: false - VALIDATE_NATURAL_LANGUAGE: false - VALIDATE_SHELL_SHFMT: false - VALIDATE_XML: false diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml new file mode 100644 index 000000000..fd71f7aa2 --- /dev/null +++ b/.markdownlint-cli2.yaml @@ -0,0 +1,92 @@ +# Glob patterns to include +globs: + - "content/**/*.md" + +# Glob patterns to exclude +ignores: + - "content/**/commands/**" + - "content/en/about/license.md" + - "content/LICENSE.md" + +# Markdownlint rules and configuration +# https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#rules--aliases +config: + # default: false # disable all rules + MD001: true + # MD002 deprecated + MD003: + style: atx + MD004: + style: dash + MD005: true + # MD006 deprecated + MD007: false # if enabled, throws errors when definition descriptions contain list items + # MD008 deprecated + MD009: true + MD010: true + MD011: true + MD012: true + MD013: false + MD014: true + # MD015 deprecated + # MD016 deprecated + # MD017 deprecated + MD018: true + MD019: true + MD020: true + MD021: true + MD022: true + MD023: true + MD024: true + MD025: true + MD026: true + MD027: true + MD028: false + MD029: + style: one + MD030: true + MD031: true + MD032: true + MD033: true + MD034: false + MD035: + style: --- + MD036: true + MD037: true + MD038: true + MD039: true + MD040: true + MD041: false + MD042: true + MD043: false + MD044: false + MD045: true + MD046: false + MD047: true + MD048: + style: backtick + MD049: + style: underscore + MD050: + style: asterisk + MD051: false + MD052: true + MD053: true + MD054: + autolink: true + collapsed: true + full: true + inline: true + shortcut: true + url_inline: true + MD055: + style: consistent + MD056: true + # MD057 deprecated + MD058: true + MD059: + prohibited_texts: + - click here + - here + - link + - more diff --git a/.markdownlint.yaml b/.markdownlint.yaml deleted file mode 100644 index dbb5b2ee8..000000000 --- a/.markdownlint.yaml +++ /dev/null @@ -1,27 +0,0 @@ -# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md - -MD001: false -MD002: false -MD003: false -MD004: false -MD007: false -MD012: - maximum: 2 -MD013: false -MD014: false -MD022: false -MD024: false -MD031: false -MD032: false -MD033: false -MD034: false -MD036: false -MD037: false -MD038: false -MD041: false -MD046: false -MD049: false -MD050: false -MD051: false -MD053: false -MD055: false diff --git a/.markdownlintignore b/.markdownlintignore deleted file mode 100644 index 4ac45b395..000000000 --- a/.markdownlintignore +++ /dev/null @@ -1,6 +0,0 @@ -**/commands/** -**/functions/** -**/news/** -**/showcase/** -**/zh/** -**/license.md