From 2325409f5317750a001068c2e4f49f624f1ff154 Mon Sep 17 00:00:00 2001 From: csh Date: Mon, 18 May 2026 15:55:01 +0800 Subject: [PATCH] :memo: docs(markdown): clarify optional markdownlint usage --- docs/markdown/index.md | 1 + rulesets/markdown/index.md | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/markdown/index.md b/docs/markdown/index.md index 308a3afe..d015ba5e 100644 --- a/docs/markdown/index.md +++ b/docs/markdown/index.md @@ -21,6 +21,7 @@ - 优先使用 Prettier(仓库已固定配置/脚本) - 若存在项目脚本,优先使用 `npm run format:md`;否则可用 `npx prettier -w ` - 不引入新的 Markdown 格式化工具 +- `markdownlint` 属于可选的结构校验增强;默认不作为本规则的部署前提 ## 关联规则 diff --git a/rulesets/markdown/index.md b/rulesets/markdown/index.md index 9603d602..fbe7ae07 100644 --- a/rulesets/markdown/index.md +++ b/rulesets/markdown/index.md @@ -20,6 +20,7 @@ - 优先使用 Prettier(仓库已固定配置/脚本) - 不引入新的 Markdown 格式化依赖 +- `markdownlint` 如需启用,由目标项目自行增加;不属于本规则集默认部署内容 ### 行内代码