From 2906f8ebe70ea5efb566ab5186875d4d7d7b3db7 Mon Sep 17 00:00:00 2001
From: Dan Barr <dan@stacklok.com>
Date: Thu, 9 Jan 2025 17:26:41 -0500
Subject: [PATCH 1/2] Disable MD034 / no-bare-urls

While we should avoid bare URLs, the fix for this rule (surrounding
the URL with <>) breaks rendering, since Docusaurus currently runs all
files through the MDX engine.
---
 .markdownlint.json | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.markdownlint.json b/.markdownlint.json
index 162d4d7..717f9f9 100644
--- a/.markdownlint.json
+++ b/.markdownlint.json
@@ -10,6 +10,7 @@
     "code_blocks": false,
     "tables": false
   },
+  "no-bare-urls": false,
   "hr-style": {
     "style": "---"
   },

From 0a3e1e9433a7a6e0647cb998d82b298a1dda6055 Mon Sep 17 00:00:00 2001
From: Dan Barr <dan@stacklok.com>
Date: Thu, 9 Jan 2025 17:30:37 -0500
Subject: [PATCH 2/2] Sort markdownlint config by name

(instead of rule ID)
---
 .markdownlint.json | 34 +++++++++++++++++-----------------
 1 file changed, 17 insertions(+), 17 deletions(-)

diff --git a/.markdownlint.json b/.markdownlint.json
index 717f9f9..7d92432 100644
--- a/.markdownlint.json
+++ b/.markdownlint.json
@@ -1,36 +1,36 @@
 {
+  "code-block-style": {
+    "style": "fenced"
+  },
+  "code-fence-style": {
+    "style": "backtick"
+  },
+  "emphasis-style": {
+    "style": "underscore"
+  },
   "heading-style": {
     "style": "atx"
   },
-  "ul-style": {
-    "style": "dash"
+  "hr-style": {
+    "style": "---"
   },
   "line-length": {
-    "line_length": 80,
     "code_blocks": false,
+    "line_length": 80,
     "tables": false
   },
   "no-bare-urls": false,
-  "hr-style": {
-    "style": "---"
-  },
   "proper-names": {
-    "names": ["CodeGate", "Copilot", "GitHub"],
-    "code_blocks": false
-  },
-  "code-block-style": {
-    "style": "fenced"
-  },
-  "code-fence-style": {
-    "style": "backtick"
-  },
-  "emphasis-style": {
-    "style": "underscore"
+    "code_blocks": false,
+    "names": ["CodeGate", "Copilot", "GitHub"]
   },
   "strong-style": {
     "style": "asterisk"
   },
   "table-pipe-style": {
     "style": "leading_and_trailing"
+  },
+  "ul-style": {
+    "style": "dash"
   }
 }