chore: ✨ Update markdownlint configuration and changelog

HeyItsGilbert · HeyItsGilbert · commit 6cf2f541381a · 2025-03-31T07:58:58.000-07:00
* Added new rules for `MD013` to disable checks for code blocks and tables.
* Documented breaking changes in `CHANGELOG.md` regarding UTF-8 file compilation and markdown file overwriting.
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -2,5 +2,9 @@
   "$schema": "https://raw.githubusercontent.com/DavidAnson/vscode-markdownlint/refs/heads/main/markdownlint-config-schema.json",
   "MD024": {
     "siblings_only": true
+  },
+  "MD013": {
+    "code_blocks": false,
+    "tables": false
   }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,9 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+### Breaking Changes
+
 - [**#71**](https://github.com/psake/PowerShellBuild/pull/71) Compiled modules
   are now explicitly created as UTF-8 files.
-
+- [**#67**](https://github.com/psake/PowerShellBuild/pull/67) Overwrite existing
+  markdown files and use the comment based help as the source of truth. This can
+  be disabled if `$PSBPreference.Docs.Overwrite` is set to `$false`.
 
 ## [0.6.2] 2024-10-06
 
diff --git a/README.md b/README.md

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,9 @@`
`2`	`2`	`"$schema": "https://raw.githubusercontent.com/DavidAnson/vscode-markdownlint/refs/heads/main/markdownlint-config-schema.json",`
`3`	`3`	`"MD024": {`
`4`	`4`	`"siblings_only": true`
	`5`	`+ },`
	`6`	`+ "MD013": {`
	`7`	`+ "code_blocks": false,`
	`8`	`+ "tables": false`
`5`	`9`	`}`
`6`	`10`	`}`