diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..e69de29
diff --git a/.github/workflows/integrate.yml b/.github/workflows/integrate.yml
index 79b1911..edd109b 100644
--- a/.github/workflows/integrate.yml
+++ b/.github/workflows/integrate.yml
@@ -21,7 +21,6 @@ jobs:
- name: 📦 Check out the codebase
uses: actions/checkout@v4.1.1
- # See: https://github.com/wagoid/commitlint-github-action
- name: 🧐 Lint commits using "commitlint"
uses: wagoid/commitlint-github-action@v6.0.1
with:
@@ -47,4 +46,21 @@ jobs:
file_or_dir: '.'
strict: true
+ markdown-linting:
+ timeout-minutes: 4
+ runs-on: ubuntu-latest
+ concurrency:
+ cancel-in-progress: true
+ group: markdown-linting-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+ steps:
+ - name: 📦 Check out the codebase
+ uses: actions/checkout@v4.1.1
+
+ - name: 🧐 Lint Markdown files
+ uses: DavidAnson/markdownlint-cli2-action@v16.0.0
+ with:
+ globs: |
+ **/*.md
+ !CHANGELOG.md
+
...
diff --git a/.markdownlint.json b/.markdownlint.json
new file mode 100644
index 0000000..57d92a7
--- /dev/null
+++ b/.markdownlint.json
@@ -0,0 +1,6 @@
+{
+ "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.34.0/schema/markdownlint-config-schema.json",
+ "line-length": false,
+ "no-inline-html": false,
+ "first-line-h1": false
+}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index a9a5d3a..a4fa11f 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -23,4 +23,13 @@ repos:
stages:
- commit-msg
+ - repo: local
+ hooks:
+ - id: markdownlint
+ name: markdownlint-cli2
+ description: Run markdownlint-cli2 on your Markdown files using the docker image
+ language: docker_image
+ types: [markdown]
+ entry: davidanson/markdownlint-cli2-rules:latest
+
...
diff --git a/Makefile b/Makefile
index c17a957..414b1ea 100644
--- a/Makefile
+++ b/Makefile
@@ -12,6 +12,11 @@ ACTION_LINT_RUNNER ?= $(DOCKER) run --rm $$(tty -s && echo "-it" || echo) \
rhysd/actionlint:latest \
-color -verbose
+MARKDOWN_LINT_RUNNER ?= $(DOCKER) run --rm $$(tty -s && echo "-it" || echo) \
+ -v $(shell pwd):/app \
+ --workdir /app \
+ davidanson/markdownlint-cli2-rules:latest
+
#
# Self documenting Makefile code
# ------------------------------------------------------------------------------------
@@ -84,6 +89,14 @@ lint-actions: ## Lint all github actions
@$(ACTION_LINT_RUNNER) | tee -a $(MAKE_LOGFILE)
.PHONY: lint-actions
+lint-md: ## Lint all markdown files using markdownlint-cli2
+ @$(MARKDOWN_LINT_RUNNER) --fix "**/*.md" "!CHANGELOG.md" | tee -a $(MAKE_LOGFILE)
+.PHONY: lint-md
+
+lint-md-dry: ## Lint all markdown files using markdownlint-cli2 in dry-run mode
+ @$(MARKDOWN_LINT_RUNNER) "**/*.md" "!CHANGELOG.md" | tee -a $(MAKE_LOGFILE)
+.PHONY: lint-md-dry
+
#
# Release
# ------------------------------------------------------------------------------------
diff --git a/README.md b/README.md
index a46ae92..fd6c133 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,66 @@
-# .github
\ No newline at end of file
+
+
+