feat: add markdownlint check (#42)

Author: yaozheng-fang

.pre-commit-config.yaml

@@ -14,3 +14,14 @@ repos:
   rev: v8.24.2
   hooks:
     - id: gitleaks
+# - repo: local
+#   hooks:
+#     - id: markdownlint-cli2
+#       name: markdownlint-cli2
+#       entry: npx
+#       args:
+#         - markdownlint-cli2
+#         - "**/*.md"
+#       language: system
+#       pass_filenames: true
+#       types: [markdown]

markdownlint-rules/required-headers.js

@@ -0,0 +1,27 @@
+"use strict";
+
+module.exports = {
+  names: ["required-headers"],
+  description: "Ensure README contains specific required headers",
+  tags: ["structure"],
+
+  function: function rule(params, onError) {
+    const requiredHeaders = [
+      "# 项目介绍",
+      "## 安装",
+      "## 使用方法",
+      "## 运行结果"
+    ];
+
+    const content = params.lines.join("\n");
+
+    requiredHeaders.forEach((header) => {
+      if (!content.includes(header)) {
+        onError({
+          lineNumber: 1,
+          detail: `Missing required header: "${header}"`
+        });
+      }
+    });
+  }
+};

template/README.md

@@ -51,12 +51,11 @@
 
 您应当在此详细说明每个目录的作用，以及其中包含的文件。
 
-## 快速开始
+## 本地运行
 
 ### 前置准备
 
-- 开通 AgentKit 服务
-- 开通某模型权限
+引导用户开通火山引擎相关服务、开通某模型权限等。如无需前置准备，同样需在此处标明。
 
 ### 依赖安装
 
@@ -80,30 +79,36 @@ uv pip install -r requirements.txt
 
 说明您的环境配置文件中的具体内容。
 
-### 本地运行
+### 调试方法
 
 通常使用 `python` 来运行项目：
 
 ```bash
 python ...
 ```
 
-### 示例提示词
+或者使用 `veadk web` 进行调试：
+
+```bash
+veadk web
+```
+
+## AgentKit 部署
+
+您需要在此详细说明如何将本项目部署到 AgentKit 平台。
+
+## 示例提示词
 
 - 提示词 1
 - 提示词 2
 - ...
 
-### 效果展示
+## 效果展示
 
 您需要在此处展示项目的运行效果，例如截图、视频等。
 
 您的截图、视频等素材资产应当放置于 `assets` 目录下。
 
-## 部署到 AgentKit
-
-您需要在此详细说明如何将本项目部署到 AgentKit 平台。
-
 ## 常见问题
 
 - 问题 1