feat: 🔨 add Panache Markdown formatter

.config/panache.toml

@@ -0,0 +1,15 @@
+flavor = "quarto"
+exclude = [".git/", ".github/", "LICENSE.md", "README.md"]
+
+[format]
+tab-width = 2
+
+[linters]
+r = "jarl"
+python = "ruff"
+rust = "clippy"
+
+[formatters]
+r = "air"
+python = "ruff"
+rust = "rustfmt"

.github/workflows/release.yml

@@ -56,7 +56,7 @@ jobs:
         with:
           command: check
 
-      # Install uv to use git-cliff and rumdl
+      # Install uv to use git-cliff and panache
       - name: Set up uv
         uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
         with:

.pre-commit-config.yaml

@@ -10,6 +10,11 @@ repos:
     hooks:
       - id: gitleaks
 
+  - repo: https://github.com/jolars/panache-pre-commit
+    rev: v2.51.0
+    hooks:
+      - id: panache-format
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0
     hooks:
@@ -28,8 +33,3 @@ repos:
     hooks:
       - id: typos
         args: [--config, .config/typos.toml, --force-exclude]
-
-  - repo: https://github.com/rvben/rumdl-pre-commit
-    rev: v0.2.28
-    hooks:
-      - id: rumdl-fmt # Auto-format

.vscode/extensions.json

@@ -14,7 +14,8 @@
     "tekumara.typos-vscode",
     "EditorConfig.EditorConfig",
     "samuelcolvin.jinjahtml",
-    "rvben.rumdl"
+    "rvben.rumdl",
+    "jolars.panache"
   ],
   "unwantedRecommendations": []
 }

.vscode/settings.json

@@ -15,8 +15,8 @@
     "perf"
   ],
   "conventional-branch.format": "{Type}/{Branch}",
-  "[quarto][qmd][jinja]": {
-    "editor.formatOnSave": false
+  "[quarto][qmd][md][jinja]": {
+    "editor.defaultFormatter": "jolars.panache"
   },
   "files.associations": {
     "justfile.jinja": "plaintext",

CHANGELOG.md

@@ -1134,7 +1134,7 @@ changelog.
 
 ### ❤️ New contributors
 
-- `@github-actions[bot]` started making automated contributions
+- `@github-actions[bot]` started making automated contributions <<<<<<< HEAD
 
 - [`@martonvago`](https://github.com/martonvago) made their first contribution
   in
@@ -1147,6 +1147,21 @@ changelog.
 - [`@lwjohnst86`](https://github.com/lwjohnst86) made their first contribution
   in
   [#150](https://github.com/seedcase-project/template-python-package/pull/150)
+  =======
 
-- [`@signekb`](https://github.com/signekb) made their first contribution in
-  [#44](https://github.com/seedcase-project/template-python-package/pull/44)
+- [`@martonvago`](https://github.com/martonvago) made their first contribution
+  in
+  [#134](https://github.com/seedcase-project/template-python-package/pull/134)
+
+- `@pre-commit-ci[bot]` started making automated contributions
+
+- `@dependabot[bot]` started making automated contributions
+
+- [`@lwjohnst86`](https://github.com/lwjohnst86) made their first contribution
+  in
+  [#150](https://github.com/seedcase-project/template-python-package/pull/150)
+
+> > > > > > > 0166ab76bf12a6825d31bc8c33b9b6a23b177d52 -
+> > > > > > > [`@signekb`](https://github.com/signekb) made their first
+> > > > > > > contribution in
+> > > > > > > [#44](https://github.com/seedcase-project/template-python-package/pull/44)

CONTRIBUTING.md

@@ -20,9 +20,9 @@ manage our project, such as to run checks and test the template. Both the uv and
 justfile websites have a more detailed guide on using uv, but below are some
 simple instructions to get you started.
 
-It's easiest to first
-[install uv](https://docs.astral.sh/uv/getting-started/installation/) and then
-install justfile with uv. Once you've installed uv, install justfile by running:
+It's easiest to first [install
+uv](https://docs.astral.sh/uv/getting-started/installation/) and then install
+justfile with uv. Once you've installed uv, install justfile by running:
 
 ```bash
 uv tool install rust-just
@@ -48,10 +48,10 @@ 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/)
-as Git messages. Using this convention allows us to be able to automatically
-create a release based on the commit message by using
+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
 [Cocogitto](https://decisions.seedcase-project.org/why-semantic-release-with-cocogitto/).
 If you don't use Conventional Commits when making a commit, we will revise the
 pull request title to follow that format. That's because we use squash merges
@@ -71,8 +71,6 @@ as explains a bit more about them and what they are used for.
   configuration, pull request templates, and a
   [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)
   file.
-- `_metadata.yml`: Quarto metadata file for the website, including information
-  about the project, such as the titles and GitHub names.
 - `_quarto.yml`: Quarto configuration file for the website, including settings
   for the website, such as the theme, navigation, and other options.
 - `_metadata.yml`: Quarto metadata file for the website, including information

docs/guide/index.qmd

@@ -10,6 +10,6 @@ listing:
     - description
 ---
 
-This guide gives an overview of how to use this template for creating a
-new Python package. It includes instructions for using the template and
+This guide gives an overview of how to use this template for creating a new
+Python package. It includes instructions for using the template and
 post-creation tasks.