diff --git a/.github/workflows/sdk-docs.yaml b/.github/workflows/sdk-docs.yaml index 80b5b2b5..66065446 100644 --- a/.github/workflows/sdk-docs.yaml +++ b/.github/workflows/sdk-docs.yaml @@ -8,6 +8,16 @@ on: workflow_dispatch: jobs: + lint: + runs-on: ubuntu-20.04 + steps: + - name: Checkout repository + uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3 + - name: Setup problem matcher + uses: xt0rted/markdownlint-problem-matcher@v1.1.0 + - name: Run markdownlint + run: npx --package markdownlint-cli markdownlint readme.md docs/**/*.md --ignore node_modules + build-vitepress: runs-on: ubuntu-20.04 steps: diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 00000000..64582e5d --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,16 @@ +# MD010/hard-tabs +MD010: + code_blocks: false + +# MD013/line-length +MD013: + line_length: 120 + +# MD028/no-blanks-blockquote +MD028: false + +# MD033/no-inline-html +MD033: + allowed_elements: + - details + - summary