feat: using node version of markdown-lint, no custom rule

.gitignore

@@ -24,3 +24,6 @@ go.work.sum
 
 # env file
 .env
+
+# Node dev tooling (markdownlint)
+node_modules/

.markdownlint-cli2.jsonc

@@ -0,0 +1,15 @@
+{
+  "customRules": ["markdownlint-rule-max-one-sentence-per-line"],
+  "gitignore": true,
+  "config": {
+    "default": true,
+    "heading-style": { "style": "atx" },
+    "ul-indent": { "indent": 2 },
+    "line-length": false,
+    "no-duplicate-heading": { "siblings_only": true },
+    "no-inline-html": {
+      "allowed_elements": ["br", "code", "details", "summary", "img", "picture", "source"]
+    },
+    "first-line-heading": true
+  }
+}

.markdownlint.yml

@@ -1,17 +0,0 @@
-default: true
-heading-style:
-  style: atx
-ul-indent:
-  indent: 2
-line-length: false
-no-duplicate-heading:
-  siblings_only: true
-no-inline-html:
-  allowed_elements:
-    - br
-    - details
-    - summary
-    - img
-    - picture
-    - source
-first-line-heading: true

Makefile

@@ -4,6 +4,7 @@ help: ## Show this help
 	@grep -E '^[a-zA-Z_-]+:.*##' $(MAKEFILE_LIST) | awk -F ':.*## ' '{printf "  %-15s %s\n", $$1, $$2}'
 
 install: ## Install dev tools
+	npm install
 	go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
 	go install github.com/checkmake/checkmake/cmd/checkmake@latest
 	go install github.com/go-gremlins/gremlins/cmd/gremlins@latest
@@ -33,7 +34,7 @@ lint-makefile: ## Lint the Makefile
 	checkmake Makefile
 
 lint-markdown: ## Lint Markdown files
-	docker run --rm -v $(CURDIR):/workdir davidanson/markdownlint-cli2 "**/*.md"
+	npx markdownlint-cli2 "**/*.md"
 
 lint: lint-go lint-makefile lint-markdown ## Lint all code
 

README.md

@@ -1,3 +1,6 @@
 # <img height="30" src="assets/logo.svg" alt="Go Cuckoo, by `mvhutz`."> Go Cuckoo
 
-A hash table that uses cuckoo hashing to achieve a worst-case O(1) lookup time. Read more about it in [the package documentation](https://pkg.go.dev/git.maximhutz.com/tools/go-cuckoo).
+A hash table that uses cuckoo hashing to achieve a worst-case O(1) lookup time.
+Read more about it in [the package documentation][docs].
+
+[docs]: https://pkg.go.dev/git.maximhutz.com/tools/go-cuckoo

package.json

@@ -0,0 +1,7 @@
+{
+  "private": true,
+  "devDependencies": {
+    "markdownlint-cli2": "^0.22.1",
+    "markdownlint-rule-max-one-sentence-per-line": "^0.0.2"
+  }
+}