pre-commit: adjust mardownlint default, md fixes

Use a style file as recommended by upstream. This makes for only one source of truth. Conserve previous upstream default for MD007 (upstream default changed here markdownlint/markdownlint#373)
lenhardt-its · May 28, 2024 · ff48144 · ff48144
1 parent 0faa805
commit ff48144
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 7 deletions.
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
diff --git a/.md_style.rb b/.md_style.rb
@@ -0,0 +1,4 @@
+all
+exclude_rule 'MD013'
+exclude_rule 'MD029'
+rule 'MD007', :indent => 2
diff --git a/.mdlrc b/.mdlrc
@@ -0,0 +1 @@
+style "#{File.dirname(__FILE__)}/.md_style.rb"
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -24,8 +24,7 @@ repos:
     rev: v0.11.0
     hooks:
       - id: markdownlint
-        args: [-r, "~MD013,~MD029"]
-        exclude: "^.git"
+        exclude: "^.github|(^docs/_sidebar\\.md$)"
 
   - repo: https://github.com/shellcheck-py/shellcheck-py
     rev: v0.10.0.1

diff --git a/docs/cloud_providers/openstack.md b/docs/cloud_providers/openstack.md
@@ -1,4 +1,3 @@
-
 # OpenStack
 
 ## Known compatible public clouds

diff --git a/docs/operations/recover-control-plane.md b/docs/operations/recover-control-plane.md
@@ -1,4 +1,3 @@
-
 # Recovering the control plane
 
 To recover from broken nodes in the control plane use the "recover\-control\-plane.yml" playbook.
Original file line number	Diff line number	Diff line change
		@@ -1,4 +1,3 @@

		# OpenStack

		## Known compatible public clouds
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,4 +1,3 @@

		# Recovering the control plane

		To recover from broken nodes in the control plane use the "recover\-control\-plane.yml" playbook.
Expand Down