Add markdownlint with pre-commit (SalamLang#36)

anwarhossain1 · Mar 2, 2024 · b6a614a · b6a614a
1 parent f8e6e3e
commit b6a614a
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 17 deletions.
diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml
@@ -0,0 +1,2 @@
+# MD040/fenced-code-language Fenced code blocks should have a language specified
+MD040: false
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -14,3 +14,12 @@ repos:
     rev: v4.4.0
     hooks:
       - id: end-of-file-fixer
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.39.0
+    hooks:
+      - id: markdownlint
+        name: Run markdownlint
+        description: Check Markdown files with markdownlint
+        entry: markdownlint -c .github/linters/.markdown-lint.yml .
+        types: [markdown]
+        files: \.md$
diff --git a/docs/README.md b/docs/README.md
@@ -4,33 +4,35 @@
 
 ### Name
 
-Salam or Sallam or Salaam
+`Salam` or `Sallam` or `Salaam`
 
 ### Website
 
-https://salamlang.ir
+<https://salamlang.ir>
 
-https://salamlaang.ir
+<https://salamlaang.ir>
 
 ## Keywords
 
-FUNCTION        |        عملکرد
-RETURN        |        برگشت
-BREAK        |        توقف
-CONTINUE        |        ادامه
-PRINT        |        نمایش
-IF        |        اگر
-NULL        |        پوچ
-
-UNTIL        |        تا
-TRUE        |        درست
-FALSE        |        غلط
-ELSEIF        |        واگرنه
-AND        |        و
-OR        |        یا
+```
+FUNCTION    |   عملکرد
+RETURN      |   برگشت
+BREAK       |   توقف
+CONTINUE    |   ادامه
+PRINT       |   نمایش
+IF          |   اگر
+NULL        |   پوچ
+UNTIL       |  تا
+TRUE        |   درست
+FALSE       |   غلط
+ELSEIF      |   واگرنه
+AND         |   و
+OR          |   یا
+```
 
 ## Operators
 
+```
 و  AND
 یا   OR
 =
@@ -44,6 +46,7 @@ OR        |        یا
 -
 *
 /
+```
 
 ## Syntax