# Markdown Checker

> 检查 markdown 文件的语法、样式、错别字和排版问题。使用此 skill 当用户需要检查、验证或修复 markdown 文件时，包括：检查标题层级、链接格式、代码块语法、列表格式、空格和缩进、标点符号使用、段落间距等问题。

- Skill: `zxhfighter/markdown-checker` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add zxhfighter/markdown-checker`
- Raw SKILL.md: https://api.skillmd.com/api/skills/zxhfighter/markdown-checker/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: zxhfighter (https://skillmd.com/u/zxhfighter)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/zxhfighter/markdown-checker

---


# Markdown Checker

## Overview

检查并修复 markdown 文件的语法、样式、错别字和排版问题，确保文档质量。

## Quick Start

检查单个 markdown 文件：

```bash
python3 scripts/check_markdown.py path/to/file.md
```

## 检查项目

### 1. 语法检查

#### 标题层级
- 检查标题是否跳级（如从 H1 直接跳到 H3）
- 验证 ATX 风格标题格式（# 标题）

#### 链接格式
- 检查空链接文本 `[]()`
- 检查缺少 URL 的链接 `[text]()`
- 检查链接 URL 中包含空格

#### 代码块
- 检查代码块是否指定语言
- 检查代码块是否正确闭合

#### 列表格式
- 检查无序列表符号后缺少空格
- 检查有序列表数字后缺少空格

### 2. 样式检查

#### 空格和缩进
- 检查行尾多余空格
- 检查是否使用 Tab 缩进（建议使用空格）

#### 段落间距
- 检查连续空行超过 2 行

### 3. 排版检查

#### 标点符号
- 检查中文标点后是否缺少空格（如果后面有英文）
- 检查英文和中文之间是否缺少空格

## 使用脚本

运行检查脚本：

```bash
python3 scripts/check_markdown.py <文件路径>
```

脚本会输出详细的检查报告，包括：
- ❌ 错误（必须修复）
- ⚠️ 警告（建议修复）
- ℹ️ 提示（可选修复）

## 手动检查流程

当需要手动检查 markdown 文件时：

1. **读取文件**
   - 使用 Read 工具读取 markdown 文件内容

2. **执行检查**
   - 检查标题层级是否合理
   - 检查链接格式是否正确
   - 检查代码块是否完整
   - 检查列表格式是否规范
   - 检查空格和缩进是否一致
   - 检查标点符号使用是否规范

3. **生成报告**
   - 列出所有发现的问题
   - 按严重程度分类（错误、警告、提示）
   - 提供具体的行号和内容

4. **可选修复**
   - 如果用户要求修复，使用 Edit 工具修复问题
   - 修复后重新检查确认问题已解决

## Resources

### scripts/check_markdown.py

Python 脚本，用于自动检查 markdown 文件。

**功能：**
- 自动检测语法、样式、排版问题
- 输出详细的检查报告
- 按严重程度分类问题

**使用方法：**
```bash
python3 scripts/check_markdown.py path/to/file.md
```

**返回值：**
- 退出码 0：无错误
- 退出码 1：发现错误