Skip to content

armgit / flix

Public Imported from GitHub
0

Making an ESP32-based quadcopter from scratch

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.

Oleg Kalachevd01d5b7ecbe7
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
-}