Merge pull request #8 from jpstroop/mdformat_ci

mdformat to ci

Author: jpstroop

.github/workflows/ci.yml

@@ -122,4 +122,31 @@ jobs:
 
       - name: Check code style
         run: |
-          pdm run black --check --verbose
+          pdm run black --check --verbose
+
+  mdformat:
+    name: mdformat
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+
+      - name: Install PDM
+        run: |
+          python -m pip install --upgrade pip
+          pip install pdm
+
+      - name: Install dependencies
+        run: |
+          pdm install -G:all
+
+      - name: Check markdown style
+        run: |
+          pdm run mdformat --check --exclude ".venv/**"

README.md

@@ -7,6 +7,7 @@
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Doc style: MDformat](https://img.shields.io/badge/doc_style-mdformat-1c55ff?style=flat)](https://mdformat.readthedocs.io/en/stable/)
 [![Python 3.13+](https://img.shields.io/badge/python-3.13+-blue.svg)](https://www.python.org/downloads/release/python-3130/)
 [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
 

pyproject.toml

@@ -73,7 +73,6 @@ codeformatters = [
 extensions = [
     "gfm"
 ]
-exclude = [".venv/**"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]