Merge pull request #318 from guan404ming/add-markdownlint

✨ add markdownlint

Author: jorenham

.github/PULL_REQUEST_TEMPLATE.md

@@ -1 +1 @@
-Closes #ISSUE_NUMBER
+Closes #ISSUE_NUMBER

.markdownlint.yaml

@@ -0,0 +1,30 @@
+default: true
+no-hard-tabs: true
+
+MD007:
+  indent: 2
+MD013:
+  line_length: 130
+MD031:
+  list_items: false
+MD033:
+  allowed_elements:
+    - h1
+    - p
+    - br
+    - a
+    - i
+    - code
+    - sup
+    - sub
+    - img
+    - table
+    - tr
+    - th
+    - td
+    - dl
+    - dt
+    - dd
+    - details
+    - summary
+MD041: false

.vscode/extensions.json

@@ -4,7 +4,8 @@
     "detachhead.basedpyright",
     "ms-python.mypy-type-checker",
     "ms-python.python",
-    "tamasfe.even-better-toml"
+    "tamasfe.even-better-toml",
+    "davidanson.vscode-markdownlint"
   ],
   "unwantedRecommendations": ["ms-pyright.pyright", "ms-python.vscode-pylance"]
 }

.vscode/settings.json

@@ -2,6 +2,9 @@
   "[python]": {
     "editor.rulers": [88, 130]
   },
+  "[markdown]": {
+    "editor.rulers": [130]
+  },
   "evenBetterToml.formatter.alignComments": true,
   "evenBetterToml.formatter.allowedBlankLines": 2,
   "evenBetterToml.formatter.arrayTrailingComma": true,