mcpField
M
markdown-formatting

markdown-formatting

github.com/denolfe文档处理8839 次安装今天更新
代码仓库

关于 markdown-formatting

使用 markdownlint 格式化和检查 Markdown 与 MDX 文件的技能。它为开发者提供配置查找、问题检测、修复及复查流程。

主要功能

  1. 01Markdown 和 MDX 格式化与检查
  2. 02按顺序检测 markdownlint 配置
  3. 03识别常见规则问题
  4. 04自动修复并重新验证

适用场景

  1. 01统一项目中的 Markdown 格式
  2. 02检查文档标题、列表和空白问题
  3. 03修复 Markdown 与 MDX 文件的检查错误

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/denolfe/dotfiles --skill markdown-formatting

安装后在 Claude Code 中输入/markdown-formatting确认已加载。

附带文件rules-reference.md

详细介绍

Markdown 和 MDX 格式化与 lint 检查

使用 markdownlint CLI 工具格式化并检查 Markdown 和 MDX 文件，全面理解所有 Markdown 规则。

快速开始

# Check if markdownlint is available
which markdownlint || which markdownlint

# Install if needed
pnpm add -D markdownlint
# or
npm install -g markdownlint

# Auto-fix files (markdown and MDX)
markdownlint --fix "**/*.{md,mdx}"

# Check specific files
markdownlint README.md docs/**/*.md content/**/*.mdx

配置检测

按以下顺序检查配置文件：

  1. .markdownlint.json
  2. .markdownlint.jsonc
  3. .markdownlint.yaml
  4. .markdownlintrc
  5. package.json 中的 markdownlint 键

常见工作流

  1. 检测环境：检查是否有 markdownlint CLI
  2. 查找配置：查找配置文件
  3. 运行 lint 检查：识别问题
  4. 应用修复：自动修复或手动修复
  5. 验证：重新运行以确认

最常见的问题与快速修复

标题
  • MD001：标题级别逐级递增（# → ## → ###，不能从 # 跳到 ###）
  • MD018/MD019：井号后加一个空格（# 标题，而不是 #标题）
  • MD022：标题前后留空行
  • MD025：每个文档仅有一个 H1 标题
  • MD041：第一行应为 H1 标题

# Main Title

## Section

### Subsection

Content here...
列表
  • MD004：统一列表标记（全部使用 - 或 *）
  • MD007：嵌套列表缩进 2 个空格
  • MD030：列表标记后加一个空格
  • MD032：列表前后留空行

- Item 1
  - Nested item
  - Another nested
- Item 2
空白字符
  • MD009：行尾不能有空格
  • MD010：使用空格而非制表符
  • MD012：仅使用一个空行（不要连续使用多个）
  • MD047：文件以换行符结尾
链接与图片
  • MD034：将裸 URL 括在 <> 中：<http://example.com>
  • MD042：链接需要文本：[链接文本](url)，而不是 [](url)
  • MD045：图片需要替代文本：![描述](image.png)
代码块
  • MD031：代码块前后留空行
  • MD040：为代码块指定语言

Text before

```javascript
const code = 'here';
```

Text after

CLI 命令

# Fix all markdown and MDX files
markdownlint --fix "**/*.{md,mdx}"

# Fix specific files
markdownlint --fix README.md CHANGELOG.md content/blog.mdx

# Check without fixing
markdownlint "**/*.{md,mdx}"

# Use specific config
markdownlint --config .markdownlint.json "**/*.{md,mdx}"

# Ignore specific rules
markdownlint --disable MD013 MD033 "**/*.{md,mdx}"

# Output JSON for parsing
markdownlint --json "**/*.{md,mdx}"

常见用法

一次修复多个问题

#Title
Some text with trailing spaces
 Tab indented line

- Item 1
* Item 2
Visit http://example.com


# Title

Some text with trailing spaces
    Space indented line

- Item 1
- Item 2

Visit <http://example.com>
添加到 package.json
{
  "scripts": {
    "lint:md": "markdownlint \"**/*.{md,mdx}\" --ignore node_modules",
    "lint:md:fix": "markdownlint \"**/*.{md,mdx}\" --ignore node_modules --fix"
  }
}

详细规则参考

如需查看包含示例和修复方法的所有 Markdown 规则的完整文档，请参阅 rules-reference.md。

资源

评论

支持 Markdown