Enable pre-commit (#6)

mphowardlab · Feb 17, 2025 · da3704f · da3704f
1 parent 13a24d5
commit da3704f
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 3 deletions.
diff --git a/.mdformat.toml b/.mdformat.toml
@@ -0,0 +1,5 @@
+wrap = 80
+number = true
+extensions = [
+    "myst"
+]
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,26 @@
+ci:
+  autoupdate_schedule: quarterly
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/hukkin/mdformat
+    rev: 0.7.22
+    hooks:
+      - id: mdformat
+        additional_dependencies:
+          - mdformat-myst
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.44.0
+    hooks:
+      - id: markdownlint
diff --git a/README.md b/README.md
@@ -2,6 +2,6 @@
 
 by [Michael P. Howard](https://www.eng.auburn.edu/directory/mph0043)
 
-This is a digitized collection of course notes and problems developed for
-CHEN 2650 Chemical Engineering Applications of Mathematical Techniques at
-Auburn University.
+This is a digitized collection of course notes and problems developed for CHEN
+2650 Chemical Engineering Applications of Mathematical Techniques at Auburn
+University.
diff --git a/index.md b/index.md
@@ -1,3 +1,5 @@
+<!-- markdownlint-disable MD002 MD041 -->
+
 ```{include} README.md
 ```