hotfix: fix 701fdcd

701fdcd disabled Markdown linting and intoduced
a different note context to the README.md. This
commit fixes that.

Signed-off-by: Maryam Tahhan <[email protected]>

Author: maryamtahhan

.markdownlint.json

@@ -0,0 +1,45 @@
+{
+  "code-block-style": {
+    "style": "fenced"
+  },
+  "code-fence-style": {
+    "style": "backtick"
+  },
+  "heading-style": {
+    "style": "atx"
+  },
+  "hr-style": {
+    "style": "---"
+  },
+  "line-length": {
+    "strict": false,
+    "code_blocks": false
+  },
+  "proper-names": {
+    "code_blocks": false,
+    "names": [
+      "Markdown",
+      "markdown-it",
+      "markdownlint",
+      "markdownlint-cli2"
+    ]
+  },
+  "strong-style": {
+    "style": "asterisk"
+  },
+  "table-pipe-style": {
+    "style": "leading_and_trailing"
+  },
+  "ul-style": {
+    "style": "dash"
+  },
+  "no-duplicate-header" : {
+    "allow_different_nesting": true
+  },
+  "MD033" : false,
+  "MD041": false,
+  "MD045": false,
+  "MD025": {
+    "front_matter_title": ""
+  }
+}

.pre-commit-config.yaml

@@ -4,19 +4,14 @@ repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v2.3.0
   hooks:
-  - id: check-yaml
-  - id: end-of-file-fixer
-  - id: trailing-whitespace
-#- repo: https://github.com/markdownlint/markdownlint.git
-#  rev: v0.13.0
-#  hooks:
-  #- id: markdownlint_docker
-  #name: Markdownlint Docker
-  #description: Run markdown lint on your Markdown files using the project docker image
-  #language: docker_image
-  #files: \.(md|mdown|markdown)$
-  #entry: markdownlint/markdownlint
+    - id: check-yaml
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+- repo: https://github.com/DavidAnson/markdownlint-cli2
+  rev: v0.9.2
+  hooks:
+    - id: markdownlint-cli2-rules-docker
 - repo: https://github.com/shellcheck-py/shellcheck-py
   rev: v0.10.0.1
   hooks:
-  -   id: shellcheck
+    - id: shellcheck

README.md

@@ -37,7 +37,8 @@ Will setup container runtime on your host instance.
 
 ## Startup
 
-**note**: in 2024 July, we decoupled cluster config with kind cluster setup, so that we allow this repo to set up a existing cluster.
+> **_Note_**: in 2024 July, we decoupled cluster config with kind cluster setup,
+so that we allow this repo to set up a existing cluster.
 
 1. Modify kind [config](./kind/manifests/kind.yml) to make sure `extraMounts:` cover
    the linux header and BCC.