From d01d5b7ecbe75ecdab3925f4250136c585a85350 Mon Sep 17 00:00:00 2001
From: Oleg Kalachev <okalachev@gmail.com>
Date: Tue, 17 Dec 2024 17:16:19 +0300
Subject: [PATCH] Improve Markdown linting * Move .markdownlint to the root so
 it applies to the main readme. * Improve .markdownlint, enable proper names
 checks. * Use markdownlint-cli2 instead of markdownlint-cli as it's more
 compatible with VSCode extension.

---
 .github/workflows/docs.yml |  4 +--
 .markdownlint.json         | 67 ++++++++++++++++++++++++++++++++++++++
 docs/.markdownlint.json    | 10 ------
 3 files changed, 69 insertions(+), 12 deletions(-)
 create mode 100644 .markdownlint.json
 delete mode 100644 docs/.markdownlint.json

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 0aca488..038e4ef 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -17,9 +17,9 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Install markdownlint
-      run: npm install -g markdownlint-cli
+      run: npm install -g markdownlint-cli2
     - name: Run markdownlint
-      run: cd docs && markdownlint .
+      run: markdownlint-cli2 "**/*.md"
 
   build_book:
     runs-on: ubuntu-latest
diff --git a/.markdownlint.json b/.markdownlint.json
new file mode 100644
index 0000000..ad07c47
--- /dev/null
+++ b/.markdownlint.json
@@ -0,0 +1,67 @@
+{
+	"MD004": {
+		"style": "asterisk"
+	},
+	"MD010": false,
+	"MD013": false,
+	"MD024": false,
+	"MD033": false,
+	"MD034": false,
+	"MD044": {
+		"html_elements": false,
+		"code_blocks": false,
+		"names": [
+			"FlixPeriph",
+			"Wi-Fi",
+			"STM",
+			"Li-ion",
+			"GitHub",
+			"github.com",
+			"PPM",
+			"PWM",
+			"Futaba",
+			"S.Bus",
+			"C++",
+			"PID",
+			"Arduino IDE",
+			"Arduino",
+			"Arduino Nano",
+			"ESP32",
+			"IMU",
+			"MEMS",
+			"imu.ino",
+			"InvenSense",
+			"MPU-6050",
+			"MPU-9250",
+			"GY-91",
+			"ICM-20948",
+			"Linux",
+			"Windows",
+			"macOS",
+			"iOS",
+			"Android",
+			"Bluetooth",
+			"GPS",
+			"GPIO",
+			"USB",
+			"SPI",
+			"I²C",
+			"UART",
+			"GND",
+			"3V3",
+			"VCC",
+			"SCL",
+			"SDA",
+			"SAO",
+			"AD0",
+			"MOSI",
+			"MISO",
+			"NCS",
+			"MOSFET",
+			"ArduPilot",
+			"Betaflight",
+			"PX4"
+		]
+	},
+	"MD045": false
+}
diff --git a/docs/.markdownlint.json b/docs/.markdownlint.json
deleted file mode 100644
index a06044b..0000000
--- a/docs/.markdownlint.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
-	"MD004": {
-		"style": "asterisk"
-	},
-	"MD010": false,
-	"MD013": false,
-	"MD024": false,
-	"MD033": false,
-	"MD045": false
-}