From 66d60a7e61283668c7dbbd0a00839c099b84a2a5 Mon Sep 17 00:00:00 2001
From: Yann Hamdaoui <yann.hamdaoui@gmail.com>
Date: Wed, 3 Aug 2022 16:16:22 +0200
Subject: [PATCH] Enable markdown linting

Add configuration for markdown linting (disabling some rules) and enable
markdown linting in the pre-commit hooks and the checks of the flake.
---
 .markdownlint.json | 10 ++++++++++
 flake.nix          |  6 +++++-
 2 files changed, 15 insertions(+), 1 deletion(-)
 create mode 100644 .markdownlint.json

diff --git a/.markdownlint.json b/.markdownlint.json
new file mode 100644
index 00000000..840bd891
--- /dev/null
+++ b/.markdownlint.json
@@ -0,0 +1,10 @@
+{
+    "default": true,
+    "MD013": {
+        "code_blocks": false,
+        "tables": false
+    },
+    "MD024": {
+        "allow_different_nesting": true
+    }
+}
diff --git a/flake.nix b/flake.nix
index caf13733..f1b725e0 100644
--- a/flake.nix
+++ b/flake.nix
@@ -170,6 +170,10 @@
               };
               markdownlint = {
                 enable = true;
+                excludes = [
+                  "notes/(.+)\\.md$"
+                  "^RELEASES\\.md$"
+                ];
               };
             };
           };
@@ -326,7 +330,7 @@
           name = channel;
           value = buildNickel { inherit channel; isDevShell = true; };
         }
-      ));
+        ));
 
       checks = {
         # wasm-opt can take long: eschew optimizations in checks