WIP: adding a md linter to the lint process

.editorconfig

@@ -8,9 +8,5 @@ end_of_line = lf
 insert_final_newline = true
 indent_style = space
 indent_size = 2
-max_line_length = 80
+max_line_length = 100
 trim_trailing_whitespace = true
-
-[*.md]
-insert_final_newline = false
-trim_trailing_whitespace = false

.eslintignore

@@ -1,7 +1,6 @@
 build/
 .eslintrc.js
+.eslintrc.md.js
 docs/test-api
 ./node_modules/*
-*.md
-*.mdx
 LICENSE

.eslintrc.md.js

@@ -0,0 +1,34 @@
+module.exports = {
+  extends: [
+    "plugin:markdownlint/recommended",
+  ],
+  "parser": "eslint-plugin-markdownlint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    },
+  },
+  rules: {
+    // https://github.com/DavidAnson/markdownlint?tab=readme-ov-file
+    "markdownlint/md001": "off",
+    "markdownlint/md003": "warn",
+    // line length
+    "markdownlint/md013": ["error", {
+      "line_length": 100,
+      "code_block_line_length": 100,
+      "code_blocks": true,
+    }],
+    // allow headings with the same content
+    "markdownlint/md024": "off",
+    // allow multiple ## and # in the same file
+    "markdownlint/md025": ["error", {
+      "level": 3
+    }],
+    // allow inline html
+    "markdownlint/md033": "off",
+    // allowed here, not for real docs
+    "markdownlint/md051": "off",
+  }
+};

.github/workflows/spelling.yml

@@ -0,0 +1,22 @@
+---
+name: Check for spelling with vale
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  vale:
+    name: Spelling
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Vale
+        uses: ConsenSys/docs-gha/spelling@main
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

.github/workflows/trivy.yml

@@ -0,0 +1,18 @@
+---
+name: Trivy
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  trivy:
+    name: Run trivy scanner
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Trivy
+        uses: ConsenSys/docs-gha/trivy@main
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}