updated markdown lint rules

.github/workflows/pr-checks.yml

@@ -6,7 +6,7 @@ on:
     paths: 
       - 'docs/**'
       - 'mkdocs.yml'
-      # TODO: add the linter style/config files here later so that it triggers when the config changes
+      - '.markdownlint.jsonc'
 
 jobs:
   lint:

.markdownlint.jsonc

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json",
+
+  // Start with no rules, then enable only checks for defects and consistency.
+  "default": false,
+
+  // Document structure
+  "MD001": true,
+
+  // Consistency without prescribing a particular Markdown style
+  "MD003": { "style": "consistent" },
+  "MD004": { "style": "consistent" },
+  "MD005": true,
+  "MD029": { "style": "one_or_ordered" },
+
+  // Whitespace and delimiter errors
+  "MD009": true,
+  "MD010": { "code_blocks": false },
+  "MD012": true,
+  "MD018": true,
+  "MD019": true,
+  "MD020": true,
+  "MD021": true,
+  "MD027": true,
+  "MD030": true,
+  "MD037": true,
+  "MD039": true,
+
+  // Broken or ambiguous Markdown syntax
+  "MD011": true,
+  "MD028": true,
+  "MD042": true,
+  "MD047": true,
+  "MD052": true,
+  "MD053": true,
+  "MD056": true
+}

docs/index.md

@@ -2,4 +2,4 @@
 
 This is an index file for my docs as code thing.
 
-I **love** docs as code!
+I **love** docs as code!

docs/stack.md

@@ -4,15 +4,15 @@ I'm using these tools in the pipeline.
 
 ## Authoring
 
-I write markdown files with **Notepad++**. 
+I write markdown files with **Notepad++**.
 
 I use the following plugins:
 
 - [AnotherMarkdown](https://github.com/ezyuzin/NppAnotherMarkdown)
 
 ## Versioning
 
-I use Git on Windows locally. I host the repository on GitHub. 
+I use Git on Windows locally. I host the repository on GitHub.
 
 [Open the repository](https://github.com/davidstula/docsmachine)
 
@@ -24,10 +24,10 @@ I use [mkDocs](https://www.mkdocs.org/) to generate and serve a local version of
 
 ## Automation
 
-A GitHub Action workflow executes on a pull request to the "master" branch. The workflow runs on an Ubuntu runner with Python and does the following: 
+A GitHub Action workflow executes on a pull request to the "master" branch. The workflow runs on an Ubuntu runner with Python and does the following:
 
 1. Install mkDocs.
 1. Check out the master branch.
 1. Run ```mkdocs build```.
 1. Upload the resulting ```site``` folder to Github Pages as an artifact.
-1. Deploy the pages.
+1. Deploy the pages.