feat: markdown lint (#1307)

Author: SkyeYoung

.remarkrc.mjs

@@ -0,0 +1,28 @@
+import remarkFrontmatter from 'remark-frontmatter';
+import rlFmSchema from '@julian_cataldo/remark-lint-frontmatter-schema';
+
+
+const remarkConfig = {
+    plugins: [
+        "remark-preset-lint-consistent",
+        "remark-preset-lint-recommended",
+        "remark-preset-lint-markdown-style-guide",
+        ["remark-lint-maximum-line-length", false],
+        ["maximum-heading-length", false],
+        ["remark-lint-ordered-list-marker-value", [1, "ordered"]],
+        remarkFrontmatter,
+        [
+          rlFmSchema,
+          {
+            schemas: {
+              './blog/creative-work.schema.yaml': [
+                './blog/en/blog/*.md',
+                './blog/zh/blog/*.md',
+              ],
+            },
+          },
+        ],
+      ],
+};
+
+export default remarkConfig;

blog/creative-work.schema.yaml

@@ -0,0 +1,42 @@
+type: object
+additionalProperties: false
+properties:
+  title:
+    type: string
+  tags:
+    type: array
+    items:
+      type: string
+      enum:
+        - Case Studies
+        - Community
+        - Ecosystem
+        - Authentication
+        - Security
+        - Plugins
+  keywords:
+    type: array
+  image:
+    type: string
+  description:
+    type: string
+  authors:
+    type: array
+    items:
+      type: object
+      required:
+        - name
+        - title
+      properties:
+        name:
+          type: string
+        title:
+          type: string
+        url:
+          type: string
+        image_url:
+          type: string
+required:
+  - title
+  - tags
+  - keywords

package.json

@@ -38,6 +38,7 @@
     "prepare-data": "yarn sync-docs && yarn generate-repos-info && yarn generate-picked-posts"
   },
   "devDependencies": {
+    "@julian_cataldo/remark-lint-frontmatter-schema": "^3.6.2",
     "@typescript-eslint/eslint-plugin": "^5.17.0",
     "@typescript-eslint/parser": "^5.17.0",
     "eslint": "^8.2.0",
@@ -49,12 +50,19 @@
     "eslint-plugin-yml": "^0.14.0",
     "husky": ">=6",
     "lint-staged": ">=10",
+    "remark": "^14.0.2",
+    "remark-cli": "^11.0.0",
+    "remark-frontmatter": "^4.0.1",
+    "remark-preset-lint-consistent": "^5.1.1",
+    "remark-preset-lint-markdown-style-guide": "^5.1.2",
+    "remark-preset-lint-recommended": "^6.1.2",
     "stylelint": "^14.6.1",
     "stylelint-config-standard": "^25.0.0"
   },
   "lint-staged": {
     "*.{js,jsx,ts,tsx}": "eslint --cache --fix",
     "*.{yml,yaml}": "eslint --cache --fix",
-    "*.{scss,css}": "stylelint --cache --fix"
+    "*.{scss,css}": "stylelint --cache --fix",
+    "*.{md}": "remark ./blog/{en,zh}/blog/**/*.md --quiet"
   }
 }