From 6e339530d758135297c79e615254137dbdae39c4 Mon Sep 17 00:00:00 2001 From: davidstula Date: Mon, 14 Sep 2026 14:39:10 +0200 Subject: [PATCH 1/3] updated markdown lint rules --- .github/workflows/pr-checks.yml | 1 + .markdownlint.jsonc | 37 +++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 .markdownlint.jsonc diff --git a/.github/workflows/pr-checks.yml b/.github/workflows/pr-checks.yml index 4c48da0..ad11f68 100644 --- a/.github/workflows/pr-checks.yml +++ b/.github/workflows/pr-checks.yml @@ -6,6 +6,7 @@ on: paths: - 'docs/**' - 'mkdocs.yml' + - '.markdownline.jsonc' # TODO: add the linter style/config files here later so that it triggers when the config changes jobs: diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 0000000..d83b6c6 --- /dev/null +++ b/.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 +} From c9173a8b1967810c8d72f458048813cce180261b Mon Sep 17 00:00:00 2001 From: davidstula Date: Mon, 14 Sep 2026 14:40:36 +0200 Subject: [PATCH 2/3] typo corrected --- .github/workflows/pr-checks.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/pr-checks.yml b/.github/workflows/pr-checks.yml index ad11f68..6e116d4 100644 --- a/.github/workflows/pr-checks.yml +++ b/.github/workflows/pr-checks.yml @@ -6,8 +6,7 @@ on: paths: - 'docs/**' - 'mkdocs.yml' - - '.markdownline.jsonc' - # TODO: add the linter style/config files here later so that it triggers when the config changes + - '.markdownlint.jsonc' jobs: lint: From 7925cb4c11ba72a407d3721b99d901b41bdd2d2a Mon Sep 17 00:00:00 2001 From: davidstula Date: Mon, 14 Sep 2026 14:43:07 +0200 Subject: [PATCH 3/3] corrected MD structure --- docs/index.md | 2 +- docs/stack.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index ee0e9d7..865769c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,4 +2,4 @@ This is an index file for my docs as code thing. -I **love** docs as code! \ No newline at end of file +I **love** docs as code! diff --git a/docs/stack.md b/docs/stack.md index 7e2aa38..ffc30e0 100644 --- a/docs/stack.md +++ b/docs/stack.md @@ -4,7 +4,7 @@ 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: @@ -12,7 +12,7 @@ I use the following plugins: ## 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. \ No newline at end of file +1. Deploy the pages.