Merge pull request #12 from MinBZK/feature/add-pre-commit

Add pre-commit config and .gitignore

.gitignore

@@ -0,0 +1,4 @@
+venv
+.venv
+build
+site

.markdownlint.yml

@@ -0,0 +1,13 @@
+default: true
+
+# MkDocs needs another indentation
+MD007:
+  indent: 4
+
+MD013:
+  line_length: 120
+  tables: false
+  code_blocks: false
+
+# MkDocs needs different code block styles
+MD046: false

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: no-commit-to-branch
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.39.0
+    hooks:
+      - id: markdownlint

docs/ADRs/0001-adrs.md

@@ -24,8 +24,8 @@ of the software system.
 We will utilize ADRs in our team to document and communicate architectural decisions effectively. Furthermore, we
 will publish these ADRs publicly to promote transparency and facilitate collaboration.
 
-
 ## Template
+
 Use the template below to add an ADR:
 
 ```yaml
@@ -40,4 +40,4 @@ Use the template below to add an ADR:
             - 0001-first
             - 0002-second
 ---
-```
+```

requirements-dev.txt

@@ -0,0 +1,2 @@
+-r requirements.txt
+pre-commit~=3.6

requirements.txt

@@ -1,8 +1,8 @@
 Jinja2>=2.11.1
+mkdocs==1.5.3
 mkdocs-git-revision-date-localized-plugin==1.2.2
 mkdocs-glightbox==0.3.6
+mkdocs-material==9.5.4
 mkdocs-material-adr==1.1.0
 mkdocs-material-extensions==1.3.1
-mkdocs-material==9.5.4
-mkdocs==1.5.3
 pymdown-extensions==10.7