Add markdown linting

DanNixon · Dec 5, 2023 · 2f8cec6 · 2f8cec6
1 parent 89aadb5
commit 2f8cec6
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 0 deletions.
diff --git a/.mdl_style.rb b/.mdl_style.rb
@@ -0,0 +1,4 @@
+all
+exclude_rule 'MD013'
+rule 'MD007', :indent => 2
+rule 'MD029', :style => :ordered
diff --git a/.mdlrc b/.mdlrc
@@ -0,0 +1 @@
+style '.mdl_style.rb'
diff --git a/README.md b/README.md
@@ -9,11 +9,13 @@ nixos-rebuild switch --flake .#<hostname>
 ## Home Manager
 
 Bootstrap:
+
 ```sh
 nix run nixpkgs#home-manager -- switch --flake .
 ```
 
 Normal:
+
 ```sh
 home-manager switch --flake .
 ```
diff --git a/flake.nix b/flake.nix
@@ -78,6 +78,7 @@
 
             alejandra
             treefmt
+            mdl
 
             sops
           ];

diff --git a/treefmt.toml b/treefmt.toml
@@ -5,3 +5,7 @@ excludes = [
   "*/hardware-configuration.nix",
   "modules/home-manager/email/secrets.nix",
 ]
+
+[formatter.markdown]
+command = "mdl"
+includes = [ "*.md" ]