From 0af1ed2da1722f4f6d5b849fe7d03b8c4f5375b7 Mon Sep 17 00:00:00 2001
From: Max Ammann <max@maxammann.org>
Date: Thu, 8 Feb 2024 12:16:27 +0000
Subject: [PATCH] Improve linting

---
 .github/workflows/markdown.yml                               | 5 +----
 .markdownlint-cli2.jsonc                                     | 3 +++
 .github/workflows/.markdownlint.jsonc => .markdownlint.jsonc | 0
 .markdownlintignore                                          | 1 -
 README.md                                                    | 4 ++--
 5 files changed, 6 insertions(+), 7 deletions(-)
 create mode 100644 .markdownlint-cli2.jsonc
 rename .github/workflows/.markdownlint.jsonc => .markdownlint.jsonc (100%)
 delete mode 100644 .markdownlintignore

diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml
index d6529a3..dc24003 100644
--- a/.github/workflows/markdown.yml
+++ b/.github/workflows/markdown.yml
@@ -23,10 +23,7 @@ jobs:
     - uses: actions/checkout@v3
     - uses: DavidAnson/markdownlint-cli2-action@v9
       with:
-        command: config
-        globs: |
-         .github/workflows/.markdownlint.jsonc
-         **/*.md
+        globs: "**/*.md"
   # Spellcheck Markdown files using `retext` and `remark`
   # Uses: a custom dictionary file
   spellcheck:
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
new file mode 100644
index 0000000..b374574
--- /dev/null
+++ b/.markdownlint-cli2.jsonc
@@ -0,0 +1,3 @@
+{
+      "ignores": ["content/docs/fuzzing/**", "themes/book/**", "node_modules/**"]
+}
\ No newline at end of file
diff --git a/.github/workflows/.markdownlint.jsonc b/.markdownlint.jsonc
similarity index 100%
rename from .github/workflows/.markdownlint.jsonc
rename to .markdownlint.jsonc
diff --git a/.markdownlintignore b/.markdownlintignore
deleted file mode 100644
index f100a5c..0000000
--- a/.markdownlintignore
+++ /dev/null
@@ -1 +0,0 @@
-content/docs/fuzzing/
diff --git a/README.md b/README.md
index 07f5e83..c5f663a 100644
--- a/README.md
+++ b/README.md
@@ -89,7 +89,7 @@ Your browser will be automatically refreshed with changes whenever you save a fi
 
 6. Edit, add, and create pull requests to merge your changes into `main`.
 
-7. ❗Keep in mind that when you merge your PR into `main`, the content goes live in https://appsec.guide.
+7. ❗Keep in mind that when you merge your PR into `main`, the content goes live in <https://appsec.guide>.
     Our current policy forces at least one review before merging.
 
 8. For updates to the home page, edit [content/_index.md](content/_index.md)
@@ -136,7 +136,7 @@ This addon works better than pandoc.
 5. Open the copy and run the Addon.
 6. Export the markdown and apply fixes:
    - Search for occurences of `<code>` or `<strong>` or any other html tags
-   - Replace HTML tables with markdown ones (https://jmalarcon.github.io/markdowntables/)
+   - Replace HTML tables with markdown ones (<https://jmalarcon.github.io/markdowntables/>)
    - If you split your document, fix internal links.
    - Add missing images.
    - Fix `&lt;`, …, “, ’