Lint markdown files (#105)

.github/workflows/lint.js.yml

@@ -1,24 +0,0 @@
-name: Lint
-
-concurrency:
-  group: ${{ github.ref }}-lint-js
-  cancel-in-progress: true
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-          cache: 'npm'
-      - run: npm ci
-      - run: npm run lint

.github/workflows/lint.yml

@@ -0,0 +1,48 @@
+name: Lint
+
+concurrency:
+  group: ${{ github.ref }}-lint
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  typescript:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run lint:ts
+
+  links:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run lint:links
+
+  markdown:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run lint:md

.markdownlint.jsonc

@@ -0,0 +1,7 @@
+{
+  "default": true,
+  "line-length": false,
+  "no-trailing-spaces": false,
+  "single-trailing-newline": false,
+  "heading-start-left": false
+}

docs/Advanced-Features/MAP-Sampling-Angle.md

@@ -1,2 +1 @@
 # MAP Sampling Angle
-

docs/Hardware/Hardware-Circuits/STM32-Compatability.md

@@ -1,2 +1 @@
 # STM32 Compatibility with FOME
-

docs/Intro-Start-Here/HT-PID-ETB-And-VVT.md

@@ -11,6 +11,7 @@ u(t) = K_\text{p} e(t) + K_\text{i} \int_0^t e(\tau) \,\mathrm{d}\tau + K_\text{
 $$
 
 ## More Details
+
 Wikipedia's PID Controller page's [operational description](https://en.wikipedia.org/wiki/PID_controller#Fundamental_operation).
 
 More details about ETB PID control are found in the Advanced Features section's page [ETB PID and Autotune](/Advanced-Features/ETB/ETB-PID.md).

docs/Intro-Start-Here/Which-Hardware-For-Me.md

@@ -8,7 +8,7 @@ Currently there are a few sweet options for hardware, all have the same brain, b
 
 ## BRAIN
 
-### Polygonus :brain:
+### Polygonus 🧠
 
 This is where the real action happens. Designed to be consistent across different base board applications to simplify design, ensure repeatability, and reduce cost. The Polygonus (said Puh-LIG-on-us) Brain is on all FOME ECUs.
 

docs/Limits-And-Protections/CLT-RPM-Limit.md

@@ -1,2 +1 @@
 # Coolant Based RPM limit
-

docs/Quick-page.md

@@ -50,9 +50,11 @@ Once that is done you can push your changes and they will get automatically upda
 - More stuff!
 - Stuff that looks like stuff but isn't!
 
-##### Subtitle
+### Subtitle 1
 
-#### No not that kind of subtitle
+#### Subtitle 2
+
+##### Subtitle 3
 
 ### This kind of subtitle
 

package.json

@@ -6,9 +6,10 @@
     "docusaurus": "docusaurus",
     "start": "docusaurus start",
     "build": "docusaurus build",
-    "lint": "npm run lint:ts && npm run lint:links",
+    "lint": "npm run lint:ts && npm run lint:links && npm run lint:md",
     "lint:ts": "tsc",
     "lint:links": "node scripts/linkValidator.js",
+    "lint:md": "npx markdownlint-cli docs",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",