Merge pull request #47 from doc-detective/dd

Doc Detective integration

Author: hawkeyexl

.doc-detective.json

@@ -0,0 +1,29 @@
+{
+  "input": ".",
+  "defaultCommand": "runTests",
+  "relativePathBase": "file",
+  "runTests": {
+    "input": ["./docs", "./blog"],
+    "recursive": true,
+    "detectSteps": true
+  },
+  "fileTypes": [
+    {
+      "name": "Markdown/MDX",
+      "extensions": [".md", ".mdx"],
+      "testStartStatementOpen": "<!-- test-start",
+      "testStartStatementClose": "-->",
+      "testIgnoreStatement": "<!-- test-ignore -->",
+      "testEndStatement": "<!-- test-end -->",
+      "stepStatementOpen": "<!-- step-start",
+      "stepStatementClose": "-->",
+      "markup": [
+        {
+          "name": "External hyperlink/image",
+          "regex": ["\\[.*?]\\(([^/].*?)\\)"],
+          "actions": ["checkLink"]
+        }
+      ]
+    }
+  ]
+}

.github/workflows/doc-detective.yml

@@ -0,0 +1,17 @@
+name: Doc Detective
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  runTests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: doc-detective/github-action@v1
+        with:
+            exit_on_fail: true

.gitignore

@@ -21,4 +21,6 @@ yarn-error.log*
 
 *storybook.log
 
-.env
+.env
+
+testResults*