build: add markdownlint tooling

Author: castastrophe

.github/actions/file-diff/CHANGELOG.md

@@ -14,56 +14,46 @@
 - [#3488](https://github.com/adobe/spectrum-css/pull/3488) [`40c1954`](https://github.com/adobe/spectrum-css/commit/40c1954048f735a07f9edfccf3a568d38164806a) Thanks [@castastrophe](https://github.com/castastrophe)!
 - Update file table to specify if the file is deleted/moved and indicate the file size has decreased without showing percentages. This update also hardens the way in which the main file is highlighted in the table by checking for exact equals for looking for files "ending with" the file name.
 
+- Update file table to specify if the file is deleted/moved and indicate the file size has decreased without showing percentages. This update also hardens the way in which the main file is highlighted in the table by checking for exact equals for looking for files "ending with" the file name.
+
 ## 2.0.6
 
 ### Patch Changes
 
 - [#2775](https://github.com/adobe/spectrum-css/pull/2775) [`2452637`](https://github.com/adobe/spectrum-css/commit/2452637d1179b9b2b025dafeb5834720712413d7) Thanks [@castastrophe](https://github.com/castastrophe)!
 - Dependency minor and patch updates to support new features in tools leveraged
 
-<a name="2.0.5"></a>
-
-##2.0.5
+## 2.0.5
 
 🗓 2024-03-07 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
 
 **Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
 
-<a name="2.0.4"></a>
-
-##2.0.4
+## 2.0.4
 
 🗓 2024-02-12 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
 
 **Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
 
-<a name="2.0.3"></a>
-
-##2.0.3
+## 2.0.3
 
-🗓 2024-02-06
+🗓 2024-02-06 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
 
 **Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
 
-<a name="2.0.2"></a>
-
-##2.0.2
+## 2.0.2
 
 🗓 2024-01-29 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
 
 **Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
 
-<a name="2.0.1"></a>
-
-##2.0.1
+## 2.0.1
 
 🗓 2024-01-16 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
 
 **Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
 
-<a name="2.0.0"></a>
-
-#2.0.0
+## 2.0.0
 
 🗓 2023-12-12 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
 
@@ -75,17 +65,13 @@
 
 - NEW: @spectrum-css/ui-icons package for all SVG icons in the UI set.
 
-<a name="1.0.2"></a>
+## 1.0.2
 
-##1.0.2
-
-🗓 2023-11-15
+🗓 2023-11-15 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
 
 **Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
 
-<a name="1.0.1"></a>
-
-##1.0.1
+## 1.0.1
 
 🗓 2023-11-13
 

.github/workflows/development.yml

@@ -85,6 +85,8 @@ jobs:
             styles_modified_files: ${{ steps.changed-files.outputs.styles_modified_files }}
             eslint_added_files: ${{ steps.changed-files.outputs.eslint_added_files }}
             eslint_modified_files: ${{ steps.changed-files.outputs.eslint_modified_files }}
+            mdlint_added_files: ${{ steps.changed-files.outputs.mdlint_added_files }}
+            mdlint_modified_files: ${{ steps.changed-files.outputs.mdlint_modified_files }}
             plugins_modified_files: ${{ steps.changed-files.outputs.plugins_modified_files }}
             plugins_added_files: ${{ steps.changed-files.outputs.plugins_added_files }}
         permissions:
@@ -100,6 +102,17 @@ jobs:
                         - components/*/index.css
                       eslint:
                         - components/*/stories/*.js
+                      mdlint:
+                        - *.md
+                        - .storybook/*.md
+                        - .storybook/*/*.md
+                        - .storybook/*/*.mdx
+                        - components/*/*.md
+                        - components/*/stories/*.mdx
+                        - plugins/*/*.md
+                        - tokens/*.md
+                        - tools/*/*.md
+                        - ui-icons/*.md
                       plugins:
                         - plugins/**/*
 

.github/workflows/lint.yml

@@ -18,6 +18,12 @@ on:
             eslint_modified_files:
                 type: string
                 required: false
+            mdlint_added_files:
+                type: string
+                required: false
+            mdlint_modified_files:
+                type: string
+                required: false
     workflow_call:
         inputs:
             styles_added_files:
@@ -32,6 +38,12 @@ on:
             eslint_modified_files:
                 type: string
                 required: false
+            mdlint_added_files:
+                type: string
+                required: false
+            mdlint_modified_files:
+                type: string
+                required: false
 
 permissions:
     contents: read
@@ -104,3 +116,12 @@ jobs:
                   filter_mode: diff_context
                 #   eslint_flags: "components/*/stories/*.js"
                   eslint_flags: "${{ inputs.eslint_added_files }} ${{ inputs.eslint_modified_files }}"
+
+            - name: Run markdownlint on documentation
+              uses: reviewdog/[email protected]
+              with:
+                reporter: github-pr-review
+                filter_mode: diff_context
+                fail_level: error
+                markdownlint_config: "${{ github.workspace }}/.markdownlint.json"
+                markdownlint_input: "${{ inputs.mdlint_added_files }} ${{ inputs.mdlint_modified_files }}"

.markdownlint.json

@@ -0,0 +1,24 @@
+{
+    "extends": "markdownlint/style/prettier",
+    "first-line-h1": false,
+	"no-inline-html": false,
+    "no-bare-urls": false,
+    "no-duplicate-heading": {
+      "siblings_only": true
+    },
+    "code-block-style": {
+      "style": "fenced"
+    },
+    "code-fence-style": {
+      "style": "backtick"
+    },
+    "emphasis-style": {
+      "style": "underscore"
+    },
+    "strong-style": {
+      "style": "asterisk"
+    },
+    "ul-style": {
+      "style": "dash"
+    }
+}