From 87f859d7c6bfb07c70f09b55c263636e511d5e29 Mon Sep 17 00:00:00 2001
From: Franck Nijhof <git@frenck.dev>
Date: Mon, 10 Jul 2023 14:02:27 +0200
Subject: [PATCH] Enfore Markdown header style in linter (#28155)

---
 .remarkrc.js                                  |  1 +
 package-lock.json                             | 32 +++++++++++++++++++
 package.json                                  |  1 +
 .../_docs/automation/troubleshooting.markdown |  2 +-
 4 files changed, 35 insertions(+), 1 deletion(-)

diff --git a/.remarkrc.js b/.remarkrc.js
index 9b13e0d8bf9..29eeef54563 100644
--- a/.remarkrc.js
+++ b/.remarkrc.js
@@ -12,6 +12,7 @@ var remarkrc = {
     ["frontmatter"],
     ["lint-fenced-code-flag"],
     ["lint-no-shell-dollars"],
+    ["remark-lint-heading-style", "atx"],
     [
       "remark-lint-prohibited-strings",
       [
diff --git a/package-lock.json b/package-lock.json
index 08b867f99f3..7f952ed0822 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -12,6 +12,7 @@
         "remark-frontmatter": "^4.0.1",
         "remark-lint": "^9.1.2",
         "remark-lint-fenced-code-flag": "^3.1.2",
+        "remark-lint-heading-style": "^3.1.2",
         "remark-lint-no-shell-dollars": "^3.1.2",
         "remark-lint-prohibited-strings": "^3.1.0",
         "remark-stringify": "^10.0.3",
@@ -2157,6 +2158,19 @@
         "url": "https://github.com/sponsors/wooorm"
       }
     },
+    "node_modules/mdast-util-heading-style": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/mdast-util-heading-style/-/mdast-util-heading-style-2.0.1.tgz",
+      "integrity": "sha512-0L5rthU4xKDVbw+UQ7D8Y8xOEsX4JXZvemWoEAsL+WAaeSH+TvVVwFnTb3G/OrjyP4VYQULoNWU+PdZfkmNu4A==",
+      "dev": true,
+      "dependencies": {
+        "@types/mdast": "^3.0.0"
+      },
+      "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/unified"
+      }
+    },
     "node_modules/mdast-util-mdx-expression": {
       "version": "1.3.2",
       "resolved": "https://registry.npmjs.org/mdast-util-mdx-expression/-/mdast-util-mdx-expression-1.3.2.tgz",
@@ -3522,6 +3536,24 @@
         "url": "https://opencollective.com/unified"
       }
     },
+    "node_modules/remark-lint-heading-style": {
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/remark-lint-heading-style/-/remark-lint-heading-style-3.1.2.tgz",
+      "integrity": "sha512-0RkcRPV/H2bPFgeInzBkK1cWUwtFTm83I+Db/Z5tDY02GzKOosHLvxtJyj/1391/opAH1LYbHtHWffir99IUgw==",
+      "dev": true,
+      "dependencies": {
+        "@types/mdast": "^3.0.0",
+        "mdast-util-heading-style": "^2.0.0",
+        "unified": "^10.0.0",
+        "unified-lint-rule": "^2.0.0",
+        "unist-util-generated": "^2.0.0",
+        "unist-util-visit": "^4.0.0"
+      },
+      "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/unified"
+      }
+    },
     "node_modules/remark-lint-no-shell-dollars": {
       "version": "3.1.2",
       "resolved": "https://registry.npmjs.org/remark-lint-no-shell-dollars/-/remark-lint-no-shell-dollars-3.1.2.tgz",
diff --git a/package.json b/package.json
index 5013ff0dbde..6a0e4830956 100644
--- a/package.json
+++ b/package.json
@@ -7,6 +7,7 @@
     "remark-frontmatter": "^4.0.1",
     "remark-lint": "^9.1.2",
     "remark-lint-fenced-code-flag": "^3.1.2",
+    "remark-lint-heading-style": "^3.1.2",
     "remark-lint-no-shell-dollars": "^3.1.2",
     "remark-lint-prohibited-strings": "^3.1.0",
     "remark-stringify": "^10.0.3",
diff --git a/source/_docs/automation/troubleshooting.markdown b/source/_docs/automation/troubleshooting.markdown
index 8d2301c7ffe..7ade83555c9 100644
--- a/source/_docs/automation/troubleshooting.markdown
+++ b/source/_docs/automation/troubleshooting.markdown
@@ -15,7 +15,7 @@ The debugging screen is split into four features, the first being the Step Detai
 
 Automations created in YAML must have an [`id`](/docs/automation/yaml/#migrating-your-yaml-automations-to-automationsyaml) assigned in order for debugging traces to be stored.
 
-#### Traces ####
+#### Traces
 
 The last 5 traces are recorded for all automations. It is possible to change this by adding the following code to your automation.