This is an automated email from the ASF dual-hosted git repository.
zhengqiwei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push:
new 98b03b62c [doc] update doc style check (#2560)
98b03b62c is described below
commit 98b03b62c76afd7b6a20787f63295309a107fef9
Author: Jast <[email protected]>
AuthorDate: Tue Aug 20 00:31:51 2024 +0800
[doc] update doc style check (#2560)
Co-authored-by: tomsun28 <[email protected]>
---
home/docs/community/code-style-and-quality-guide.md | 5 +++++
.../current/community/code-style-and-quality-guide.md | 5 +++++
2 files changed, 10 insertions(+)
diff --git a/home/docs/community/code-style-and-quality-guide.md
b/home/docs/community/code-style-and-quality-guide.md
index c86438a57..70ddc5d51 100644
--- 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/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md
index 1cad8c3ad..9e11d3de6 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md
+++
b/home/i18n/zh-cn/docusaurus-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 命名风格
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
