feat: ✨ add rumdl Markdown formatter (#239)

# Description

Added rumdl to pre-commit hook and justfile. Also had to do some small
modifications to the Markdown files to get it to reformat correctly.

Closes #237

Needs a thorough review.

## Checklist

- [x] Ran `just run-all`

Author: lwjohnst86

.github/pull_request_template.md

@@ -4,9 +4,8 @@ EXPLANATION
 
 Closes #
 
-Needs a quick/an in-depth review.
+Needs a quick/thorough review.
 
 ## Checklist
 
-- [ ] Formatted Markdown
 - [ ] Ran `just run-all`

.pre-commit-config.yaml

@@ -15,6 +15,8 @@ repos:
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
+      - id: check-merge-conflict
+        args: [--assume-in-merge]
 
   - repo: https://github.com/commitizen-tools/commitizen
     rev: v4.13.7
@@ -25,6 +27,11 @@ repos:
   # sub-packages, which confuses pre-commit when it tries to find the latest
   # version
   - repo: https://github.com/adhtruong/mirrors-typos
-    rev: v1.43.3
+    rev: v1.43.4
     hooks:
       - id: typos
+
+  - repo: https://github.com/rvben/rumdl-pre-commit
+    rev: v0.1.18
+    hooks:
+      - id: rumdl-fmt # Auto-format

.rumdl.toml

@@ -0,0 +1,30 @@
+[global]
+# 72 to match what we have currently been using
+line_length = 72
+flavor = "quarto"
+exclude = [
+    # Common directories to exclude
+    ".github",
+    # This is auto-generated from the qmd version
+    "**/README.md",
+    # This has it's own structure
+    "**/LICENSE.md"
+]
+
+# List style: `-`
+[MD004]
+style = "dash"
+
+# Wrap list items
+[MD032]
+allow-lazy-continuation = false
+
+# Reflow text
+[MD013]
+reflow = true
+reflow-mode = "normalize"
+
+# Fix tables and their separator row
+[MD060]
+enabled = true
+style = "aligned-no-space"

.vscode/extensions.json

@@ -12,7 +12,8 @@
     "vivaxy.vscode-conventional-commits",
     "pshaddel.conventional-branch",
     "tekumara.typos-vscode",
-    "EditorConfig.EditorConfig"
+    "EditorConfig.EditorConfig",
+    "rvben.rumdl"
   ],
   // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
   "unwantedRecommendations": []

.vscode/settings.json

@@ -3,8 +3,6 @@
   "editor.wordWrap": "off",
   "editor.formatOnSave": true,
   "git.autofetch": false,
-  "quarto.visualEditor.markdownWrap": "column",
-  "quarto.visualEditor.markdownWrapColumn": 72,
   "editor.tabCompletion": "on",
   "editor.snippetSuggestions": "inline",
   "conventional-branch.type": [

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
-Since we follow [Conventional
-Commits](https://decisions.seedcase-project.org/why-conventional-commits)
+Since we follow
+[Conventional Commits](https://decisions.seedcase-project.org/why-conventional-commits)
 when writing commit messages, we're able to automatically create formal
 "releases" of the template based on the commit messages. Releases in the
 context of template are when changes occur to the `template/` files or
@@ -43,164 +43,164 @@ each release.
 
 ### Fix
 
--   :bug: overwrite `_contributor.qmd` with `>` (#207)
+- :bug: overwrite `_contributor.qmd` with `>` (#207)
 
 ### Refactor
 
--   :arrow_up: upgrade pre-commit hook versions (#208)
+- :arrow_up: upgrade pre-commit hook versions (#208)
 
 ## 0.17.9 (2025-09-10)
 
 ### Refactor
 
--   :pencil2: use `update`, not `add` for Quarto extension (#195)
+- :pencil2: use `update`, not `add` for Quarto extension (#195)
 
 ## 0.17.8 (2025-09-08)
 
 ### Fix
 
--   :hammer: ignore other dirs and files when listing todos (#200)
--   :bug: `github_repo` (via `_folder_name`) doesn't work using `update`
+- :hammer: ignore other dirs and files when listing todos (#200)
+- :bug: `github_repo` (via `_folder_name`) doesn't work using `update`
     (#197)
 
 ### Refactor
 
--   :pushpin: update pre-commit hook versions (#199)
--   :memo: simplify CHANGELOG description (#193)
--   :hammer: contributor script outputs text, output to file with
+- :pushpin: update pre-commit hook versions (#199)
+- :memo: simplify CHANGELOG description (#193)
+- :hammer: contributor script outputs text, output to file with
     justfile (#192)
--   :fire: `update-from-workflow` is too complicated and not needed
+- :fire: `update-from-workflow` is too complicated and not needed
     (#190)
 
 ## 0.17.7 (2025-09-05)
 
 ### Refactor
 
--   :memo: simplify PR template (#196)
+- :memo: simplify PR template (#196)
 
 ## 0.17.6 (2025-09-05)
 
 ### Refactor
 
--   :truck: rename to `check-python`, not `build` (#189)
+- :truck: rename to `check-python`, not `build` (#189)
 
 ## 0.17.5 (2025-09-02)
 
 ### Refactor
 
--   :wrench: can render everything in Quarto project (#183)
+- :wrench: can render everything in Quarto project (#183)
 
 ## 0.17.4 (2025-09-02)
 
 ### Refactor
 
--   :wrench: add more items to sidebar, like overview (#182)
+- :wrench: add more items to sidebar, like overview (#182)
 
 ## 0.17.3 (2025-09-02)
 
 ### Refactor
 
--   :recycle: create homepage as variable, not question (#179)
+- :recycle: create homepage as variable, not question (#179)
 
 ## 0.17.2 (2025-09-02)
 
 ### Refactor
 
--   :hammer: ignore `justfile` when listing TODO items (#181)
+- :hammer: ignore `justfile` when listing TODO items (#181)
 
 ## 0.17.1 (2025-09-02)
 
 ### Refactor
 
--   :recycle: need `date-released` in `CITATION.cff` (#180)
+- :recycle: need `date-released` in `CITATION.cff` (#180)
 
 ## 0.17.0 (2025-09-02)
 
 ### Feat
 
--   :sparkles: add CHANGELOG with some description of it (#178)
+- :sparkles: add CHANGELOG with some description of it (#178)
 
 ## 0.16.6 (2025-09-02)
 
 ### Refactor
 
--   :recycle: delete whole references folder pre and post render (#142)
+- :recycle: delete whole references folder pre and post render (#142)
 
 ## 0.16.5 (2025-09-01)
 
 ### Refactor
 
--   :truck: move GoatCounter file into `docs/includes/` (#177)
+- :truck: move GoatCounter file into `docs/includes/` (#177)
 
 ## 0.16.4 (2025-09-01)
 
 ### Refactor
 
--   :pushpin: update pre-commit versions (#171)
+- :pushpin: update pre-commit versions (#171)
 
 ## 0.16.3 (2025-09-01)
 
 ### Refactor
 
--   :hammer: use `--upgrade` when installing Python dependencies (#174)
+- :hammer: use `--upgrade` when installing Python dependencies (#174)
 
 ## 0.16.2 (2025-09-01)
 
 ### Refactor
 
--   :wrench: add `theme` option in `_quarto.yml`, and `brand` for
+- :wrench: add `theme` option in `_quarto.yml`, and `brand` for
     Seedcase (#170)
 
 ## 0.16.1 (2025-09-01)
 
 ### Refactor
 
--   :technologist: simplify the pull request template (#165)
+- :technologist: simplify the pull request template (#165)
 
 ## 0.16.0 (2025-08-26)
 
 ### Feat
 
--   :sparkles: add `update-from-template` workflow (#134)
--   :sparkles: add hosting provider variable (#153)
--   :memo: add Conduct, Contributing, and filled out README (#131)
--   :sparkles: add 404 page to template (#141)
--   :sparkles: add files with copier variables (#127)
--   :sparkles: copy over static files to template folder (#117)
--   :hammer: gitleaks pre-commit to check for credentials (#100)
--   :sparkles: add mypy to VS Code settings and extensions (#93)
--   :sparkles: add examples section to docstring template (#39)
--   🧑‍💻 add recipe `add-function` (#2)
+- :sparkles: add `update-from-template` workflow (#134)
+- :sparkles: add hosting provider variable (#153)
+- :memo: add Conduct, Contributing, and filled out README (#131)
+- :sparkles: add 404 page to template (#141)
+- :sparkles: add files with copier variables (#127)
+- :sparkles: copy over static files to template folder (#117)
+- :hammer: gitleaks pre-commit to check for credentials (#100)
+- :sparkles: add mypy to VS Code settings and extensions (#93)
+- :sparkles: add examples section to docstring template (#39)
+- 🧑‍💻 add recipe `add-function` (#2)
 
 ### Fix
 
--   :bug: need to run build workflow after version bump to get changelog
+- :bug: need to run build workflow after version bump to get changelog
     (#110)
--   :construction_worker: explicitly checkout newest version to publish
+- :construction_worker: explicitly checkout newest version to publish
     (#107)
--   :construction_worker: forgot to checkout before building and
+- :construction_worker: forgot to checkout before building and
     publishing (#106)
--   :construction_worker: only run when previous and current versions
+- :construction_worker: only run when previous and current versions
     are different (#98)
--   :construction_worker: use the `has_released` output to run or not
+- :construction_worker: use the `has_released` output to run or not
     (#97)
--   :bug: install uv in publish step and only for tags (#96)
--   :hammer: the `check-commits` recipe wasn't correctly checking them
+- :bug: install uv in publish step and only for tags (#96)
+- :hammer: the `check-commits` recipe wasn't correctly checking them
     (#48)
--   :hammer: the `check-commits` recipe wasn't correctly checking them
--   :bug: remove auto-built reference docs before/after building (#47)
--   :bug: remove auto-built reference docs before/after building
--   :fire: remove django debugger (#44)
--   add `test-python` to `run-all` (#38)
--   :hammer: update test snippet to given, when, then (#29)
-
-### Refactor
-
--   :recycle: specify svg for all badges (#157)
--   :recycle: move copier test to own file (#156)
--   :recycle: update post-copy message (#154)
--   :recycle: match copier vars in `template-website` (#152)
--   :recycle: use `bash` for `check-commits` justfile recipe (#150)
--   :wrench: include `github-actions` in dependabot config (#136)
--   :construction_worker: move `uv build` step into publish job (#101)
--   :recycle: make mypy more strict in settings (#94)
+- :hammer: the `check-commits` recipe wasn't correctly checking them
+- :bug: remove auto-built reference docs before/after building (#47)
+- :bug: remove auto-built reference docs before/after building
+- :fire: remove django debugger (#44)
+- add `test-python` to `run-all` (#38)
+- :hammer: update test snippet to given, when, then (#29)
+
+### Refactor
+
+- :recycle: specify svg for all badges (#157)
+- :recycle: move copier test to own file (#156)
+- :recycle: update post-copy message (#154)
+- :recycle: match copier vars in `template-website` (#152)
+- :recycle: use `bash` for `check-commits` justfile recipe (#150)
+- :wrench: include `github-actions` in dependabot config (#136)
+- :construction_worker: move `uv build` step into publish job (#101)
+- :recycle: make mypy more strict in settings (#94)

CODE_OF_CONDUCT.md

@@ -26,5 +26,5 @@ be reported by opening an issue or contacting one or more of the project
 maintainers.
 
 This Code of Conduct is adapted from the Contributor Covenant
-(https://contributor-covenant.org), version 1.0.0, available at
-https://contributor-covenant.org/version/1/0/0/
+(<https://contributor-covenant.org>), version 1.0.0, available at
+<https://contributor-covenant.org/version/1/0/0/>

CONTRIBUTING.md

@@ -1,13 +1,14 @@
 # Contributing
 
-## Issues and bugs :bug:
+## :bug: Issues and bugs
 
 The easiest way to contribute is to report issues or bugs that you might
-find while using `template-python-package`. You can do this by creating a
+find while using `template-python-package`. You can do this by creating
+a
 [new](https://github.com/seedcase-project/template-python-package/issues/new/choose)
 issue on our GitHub repository.
 
-## Adding or modifying content :pencil2:
+## :pencil2: Adding or modifying content
 
 If you would like to contribute content, please check out our
 [guidebook](https://guidebook.seedcase-project.org/) for more specific
@@ -50,13 +51,13 @@ history. Meaning that if you make changes to the template and try to
 test it, it won't be able to test those changes. You have to commit the
 changes first in order for copier to use them.
 
-When committing changes, please try to follow [Conventional
-Commits](https://decisions.seedcase-project.org/why-conventional-commits)
+When committing changes, please try to follow
+[Conventional Commits](https://decisions.seedcase-project.org/why-conventional-commits)
 as Git messages. Using this convention allows us to be able to
 automatically create a release based on the commit message by using
 [Commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen).
 If you don't use Conventional Commits when making a commit, we will
-revise the pull request title to follow that format, as we use [squash
-merges](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/squashing-commits/about-squash-merges)
+revise the pull request title to follow that format, as we use
+[squash merges](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/squashing-commits/about-squash-merges)
 when merging pull requests, so all other commits in the pull request
 will be squashed into one commit.

README.md

@@ -27,8 +27,8 @@ integration and delivery workflows, and supporting files for building
 robust Python packages.
 
 Check out our
-[website](https://template-python-package.seedcase-project.org/) for
-more information, such as the features it provides and a
+[website](https://template-python-package.seedcase-project.org) for more
+information, such as the features it provides and a
 [guide](https://template-python-package.seedcase-project.org/docs/guide/)
 to using the template. For a list of changes, see our
 [changelog](https://template-python-package.seedcase-project.org/docs/releases/)