Update commentary

Closes #4
edwardtheharris · Jul 22, 2024 · b55edb9 · b55edb9
1 parent c06327a
commit b55edb9
Show file tree

Hide file tree

Showing 13 changed files with 445 additions and 37 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -65,7 +65,7 @@ jobs:
       - name: Install the checker
         run: npm i -g markdownlint-cli2 markdownlint-cli2-formatter-junit --save-dev
       - name: Lint the Markdown
-        run: markdownlint-cli2 **/*.md
+        run: markdownlint-cli2 "*.md" "**/*.md"
       - name: Publish Test Results
         uses: EnricoMi/publish-unit-test-result-action@v2
         if: always()

diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@ _build/
 *.xcf
 .gnupg
 roles/reset/files/*.reset.md
+package-lock.json
+package.json
+node_modules
diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml
@@ -0,0 +1,58 @@
+###
+# ```{rubric} MarkdownLint Configuration
+# ```
+# ---
+# An example .markdownlint-cli2.yaml file
+#
+# Disable some built-in rules
+config:
+  no-multiple-blanks: true
+  no-trailing-spaces: true
+
+# Include a custom rule package
+# customRules:
+#   - markdownlint-rule-titlecase
+
+# Fix any fixable errors
+fix: true
+###
+# Define a custom front matter pattern
+# frontMatter: "<head>[^]*<\/head>"
+#
+# Ignore files referenced by .gitignore (only valid at root)
+gitignore: true
+###
+# Define glob expressions to use (only valid at root)
+globs:
+  - "#.venv"
+###
+# Define glob expressions to ignore
+ignores:
+  - "ignore*.md"
+###
+# Use a plugin to recognize math
+# markdownItPlugins:
+#   -
+#     - "@iktakahiro/markdown-it-katex"
+#
+# Additional paths to resolve module locations from
+modulePaths:
+  - "./modules"
+###
+# Disable banner message on stdout (only valid at root)
+noBanner: false
+###
+# Disable inline config comments
+noInlineConfig: false
+###
+# Disable progress on stdout (only valid at root)
+noProgress: false
+###
+# Use a specific formatter (only valid at root)
+outputFormatters:
+  -
+    - markdownlint-cli2-formatter-default
+    - markdownlint-cli2-formatter-junit
+###
+# Show found files on stdout (only valid at root)
+showFound: true