[doc] update doc style check (apache#2560)

Co-authored-by: tomsun28 <[email protected]>
Calvin979 · Aug 19, 2024 · 98b03b6 · 98b03b6
1 parent ceab302
commit 98b03b6
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/home/docs/community/code-style-and-quality-guide.md b/home/docs/community/code-style-and-quality-guide.md
@@ -61,6 +61,11 @@ limitations under the License.
 - Frontend code formatting plugin `eslint`
   Just run `npm run lint:fix` in web-app
 
+### 2.2 Document style check
+
+1. Run `mvn spotless:check` in the project to automatically detect the Markdown file format.
+2. Run `mvn spotless:apply` in the project to automatically format the Markdown file format to ensure that all documents meet the specifications.
+
 ## 3 Programming Specification
 
 ### 3.1 Naming Style

diff --git a/...ocusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md b/...ocusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md
@@ -61,6 +61,11 @@ limitations under the License.
 - 前端代码格式化插件 `eslint`
   前端运行 `npm run lint:fix`
 
+### 2.2 文档样式检查
+
+1. 在项目中运行`mvn spotless:check`，会执行Markdown文件格式自动检测。
+2. 在项目中运行`mvn spotless:apply`，会执行Markdown文件格式自动格式化，以确保所有文档都符合规范。
+
 ## 3 编程规范
 
 ### 3.1 命名风格