Add pre-commit with markdownlint

Add some rule exceptions and fix remaining issues.

Author: MakisH

.github/workflows/markdownlint.yml

@@ -1,10 +1,28 @@
-name: markdownlint
+name: pre-commit
 on: [pull_request, push]
 jobs:
-  mdl:
+  pre-commit:
+    name: pre-commit checks
     runs-on: ubuntu-latest
+
     steps:
-    - name: Check out code
-      uses: actions/checkout@v2
-    - name: Run mdl
-      uses: actionshub/markdownlint@main
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
+
+      - name: Set up Python
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
+        with:
+          python-version: "3.14"
+
+      - name: Cache pre-commit environments
+        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ runner.os }}-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Install pre-commit
+        run: python -m pip install "pre-commit==4.6.1"
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files --show-diff-on-failure --color=always
+

.markdownlint.json

@@ -0,0 +1,11 @@
+{
+  "MD007": { "indent": 4 },
+  "MD012": false,
+  "MD013": { "line_length": 999 },
+  "MD032": false,
+  "MD033": false,
+  "MD034": false,
+  "MD041": false,
+  "MD045": false,
+  "MD060": false
+}

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.49.1
+    hooks:
+      - id: markdownlint
+      - id: markdownlint-fix
+        

01_version_control/git_quiz.md

@@ -29,7 +29,7 @@ cat motivation.txt
 - `Documenting major milestones.`
 - The following:
 
-```
+```text
 Sharing information about myself.
 Documenting major milestones.
 ```

01_version_control/merge_rebase_slides.md

@@ -90,7 +90,7 @@ slideOptions:
 
 - `git log`
 
-    ```
+    ```text
     3e70cb5 8 seconds .. Merge branch 'feature' HEAD -> main
     607a08a 18 seconds.. E feature
     2e4f61f 28 seconds.. C

01_version_control/my_favorite_neat_little_git_trick_demo.md

@@ -10,7 +10,7 @@
 - GitHub uses [gitignore templates](https://github.com/github/gitignore) if you create a `.gitignore` file from GitHub
 - To get a nice compact `git log`, you can add the following to your `gitconfig`:
 
-    ```
+    ```rc
     [format]
             pretty = format:%C(auto,yellow)%h %C(auto,blue)%>(12,trunc)%ad %C(auto,green)%<(20,trunc)%aN%C(auto,reset)%s%C(auto,red)% gD% D
     ```
@@ -24,7 +24,7 @@
 - Prefer `git add -p` over `git add [FILE]`. This allows you to specify what you want to add to a commit in a more fine-grained manner
 - A very nice alias for editing any earlier commit, without having to manually rebase:
 
-    ```
+    ```rc
     [alias]
         amend = "!f() { \
             COMMIT=$(git rev-parse --short \"$1\") && \
@@ -45,7 +45,7 @@
 - GitHub uses [gitignore templates](https://github.com/github/gitignore) if you create a `.gitignore` file from GitHub
 - To get a nice compact `git log`, you can add the following to your `gitconfig`:
 
-    ```
+    ```rc
     [format]
             pretty = format:%C(auto,yellow)%h %C(auto,blue)%>(12,trunc)%ad %C(auto,green)%<(20,trunc)%aN%C(auto,reset)%s%C(auto,red)% gD% D
     ```
@@ -76,7 +76,7 @@
 - GitHub uses [gitignore templates](https://github.com/github/gitignore) if you create a `.gitignore` file from GitHub
 - To get a nice compact `git log`, you can add the following to your `gitconfig`:
 
-    ```
+    ```rc
     [format]
             pretty = format:%C(auto,yellow)%h %C(auto,blue)%>(12,trunc)%ad %C(auto,green)%<(20,trunc)%aN%C(auto,reset)%s%C(auto,red)% gD% D
     ```
@@ -93,7 +93,7 @@
 
 ### A helpful git config
 
-```
+```rc
 [push]
         default = simple
         autoSetupRemote = true

01_version_control/standards_slides.md

@@ -73,12 +73,12 @@ Certain files lead to special formatting (normally directly at root of repo):
 ## Special Files (3)
 
 - `CITATION.cff`
-  - ... contains preferred citation details.
-  - ... gets rendered on the sidebar.
-  - ... export to BibTeX.
+    - ... contains preferred citation details.
+    - ... gets rendered on the sidebar.
+    - ... export to BibTeX.
 - `AGENTS.md`
-  - ... contains context and instructions for GenAI.
-  - ... more and more coding agents read it.
+    - ... contains context and instructions for GenAI.
+    - ... more and more coding agents read it.
 
 
 ---

03_building_and_packaging/make_demo.md

@@ -43,6 +43,8 @@ int main()
 
 `Makefile`:
 
+<!-- markdownlint-configure-file {"MD010": false } -->
+
 ```makefile
 sse.o : sse/sse.hpp sse/sse.cpp
 	$(CXX) -c sse/sse.cpp
@@ -72,7 +74,7 @@ helloworld : main.cpp sse.o
 - `mkdir clean` and `make clean` confuses Make.
 - phony target (a helper target, doesn't correspond to a file)
 
-```
+```makefile
 + .PHONY : all clean
 ```
 

04_documentation/examples/pandoc/example.md

@@ -4,7 +4,7 @@ author: Firstname lastname
 date: 2026-01-07
 ---
 
-# Introduction
+## Introduction
 
 This is text, **bold text**, *italic text*, and `inline code`.
 

04_documentation/technical_writing_slides.md

@@ -128,6 +128,8 @@ a community of technical writers.
 
 ## Documentation Content Should Be
 
+<!-- markdownlint-configure-file {"MD059": false } -->
+
 - **ARID** (*"Accept (some) Repetition in Documentation"*)
     - Not like good code (**DRY**: *"don't repeat yourself"*),
       but also not **WET**