From c7920ccdce6bbf24545e83df863ab428c3a7a804 Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Mon, 19 Aug 2024 15:11:00 +0200 Subject: [PATCH 1/5] Lint 3.0.4.md --- .github/workflows/validate-markdown.yaml | 2 ++ versions/.markdownlint.yaml | 16 ++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 versions/.markdownlint.yaml diff --git a/.github/workflows/validate-markdown.yaml b/.github/workflows/validate-markdown.yaml index 43050e4870..4088b16758 100644 --- a/.github/workflows/validate-markdown.yaml +++ b/.github/workflows/validate-markdown.yaml @@ -29,4 +29,6 @@ jobs: node-version: '20.x' - name: Validate markdown run: npx --yes mdv versions/3.*.md + - name: Lint markdown v3.1.1 + run: npx --yes markdownlint-cli --config versions/.markdownlint.yaml versions/3.1.1.md diff --git a/versions/.markdownlint.yaml b/versions/.markdownlint.yaml new file mode 100644 index 0000000000..c8955c967a --- /dev/null +++ b/versions/.markdownlint.yaml @@ -0,0 +1,16 @@ + # Unordered list symbol + MD004: + style: asterisk + + # Unordered list indentation + MD007: + indent: 2 + + MD012: false # allow blank lines + + MD013: + line_length: 800 + tables: false + + MD024: false # duplicate headings + MD033: false # inline HTML From 15b48479c66f151432cad6ec015ac76842b06700 Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Tue, 20 Aug 2024 13:12:52 +0200 Subject: [PATCH 2/5] Update .markdownlint.yaml --- versions/.markdownlint.yaml | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/versions/.markdownlint.yaml b/versions/.markdownlint.yaml index c8955c967a..b21f293e91 100644 --- a/versions/.markdownlint.yaml +++ b/versions/.markdownlint.yaml @@ -1,16 +1,16 @@ - # Unordered list symbol - MD004: - style: asterisk +# Unordered list symbol +MD004: + style: asterisk - # Unordered list indentation - MD007: - indent: 2 +# Unordered list indentation +MD007: + indent: 2 - MD012: false # allow blank lines +MD012: false # allow blank lines - MD013: - line_length: 800 - tables: false +MD013: + line_length: 800 + tables: false - MD024: false # duplicate headings - MD033: false # inline HTML +MD024: false # duplicate headings +MD033: false # inline HTML From 0c95ec51a5d63a77e5775eca2cb90cc82f962c9d Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Thu, 22 Aug 2024 13:21:22 +0200 Subject: [PATCH 3/5] Cleanup --- .github/workflows/validate-markdown.yaml | 4 ++-- versions/.markdownlint.yaml | 16 ---------------- 2 files changed, 2 insertions(+), 18 deletions(-) delete mode 100644 versions/.markdownlint.yaml diff --git a/.github/workflows/validate-markdown.yaml b/.github/workflows/validate-markdown.yaml index 4088b16758..19e7ce093d 100644 --- a/.github/workflows/validate-markdown.yaml +++ b/.github/workflows/validate-markdown.yaml @@ -23,12 +23,12 @@ jobs: fetch-depth: 0 - name: use the javascript environment from main run: | - git checkout remotes/origin/main -- package.json package-lock.json + git checkout remotes/origin/main -- package.json package-lock.json .markdownlint.yaml - uses: actions/setup-node@v4 # setup Node.js with: node-version: '20.x' - name: Validate markdown run: npx --yes mdv versions/3.*.md - name: Lint markdown v3.1.1 - run: npx --yes markdownlint-cli --config versions/.markdownlint.yaml versions/3.1.1.md + run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/3.1.1.md diff --git a/versions/.markdownlint.yaml b/versions/.markdownlint.yaml deleted file mode 100644 index b21f293e91..0000000000 --- a/versions/.markdownlint.yaml +++ /dev/null @@ -1,16 +0,0 @@ -# Unordered list symbol -MD004: - style: asterisk - -# Unordered list indentation -MD007: - indent: 2 - -MD012: false # allow blank lines - -MD013: - line_length: 800 - tables: false - -MD024: false # duplicate headings -MD033: false # inline HTML From 7b77bec6518e5f2b5480a63ef67f7d9fd65364f5 Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Thu, 22 Aug 2024 13:31:34 +0200 Subject: [PATCH 4/5] Update package.json --- package.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 59851cb7dc..886c777180 100644 --- a/package.json +++ b/package.json @@ -31,5 +31,8 @@ "Swagger", "schema", "API" - ] + ], + "scripts": { + "format-markdown": "npx prettier --write --single-quote versions/3.1.1.md && npx --yes markdownlint-cli --fix --config .markdownlint.yaml versions/3.1.1.md" + } } From d37c58ec5a2b0e59669588169e90d639c0dca79f Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Thu, 22 Aug 2024 15:23:18 +0200 Subject: [PATCH 5/5] Create .markdownlint.yaml --- .markdownlint.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .markdownlint.yaml diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000000..7c39652d0d --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,16 @@ +# Unordered list symbol +MD004: + style: asterisk + +# Unordered list indentation +MD007: + indent: 2 + +MD012: false # allow blank lines + +MD013: + line_length: 800 + tables: false + +MD024: false # duplicate headings +MD033: false # inline HTML