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/Basic-Features/Idle-Control/Idle-Tuning.md

@@ -39,7 +39,7 @@ The first step of tuning the idle RPM is to set up the open loop idle airflow. S
   To tune the ignition table, start by setting the maximum and minimum values about 500RPM above and below your target idle speed and interpolate the values between these. At your target idle speed in the table, put in your desired timing angle. 10 degrees is a good starting point but a higher timing angle such as 15 degrees will give the engine a bit more torque at idle which helps the engine to quickly rev up from idle. The idle timing angle will vary from engine to engine so it is always worth researching what others have used on your specific engine.
 
   The next step is to fill in the remaining cells of the idle timing table. At the minimum RPM, a value of 20 degrees is recommended as this is roughly where maximum brake torque (MBT) is. To fill in the gaps between the minimum and target RPM, use the interpolation button. For the maximum engine RPM value, a value in the range of 0-10 degrees less than the target is recommended (do not go below 0 degrees of timing). Once again, interpolate the values between the maximum RPM and target. For the RPM values above idle target, if you have AC, it can actually be beneficial to leave the spark angles as the same as the idle target. This allows the engine to idle up and increase the torque to compensate when the AC is enabled. If the timing reduces above target, the idle air valve (when tuned for closed loop) may need to compensate more for the extra load on the engine.
-  
+
   Run the car with your values and see how well it maintains idle. Give it a few throttle blips to see how the idle settles. Start to adjust the timing values so that the timing pushes and pulls the engine RPM to the target and stabilizes within 50 RPM. You may need to change the shape of the idle timing curve so that only small timing adjustments are made near target and large corrections are made if the RPM significantly deviates. The trick is to essentially make a table of accurate guesses for what the timing will need to be in order to kick the engine RPM back to the target. The better your guesses are, the less work the closed loop timing controller will need to do when you implement it.
 
 ## Closed Loop Idle

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  
-
+# 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",