Markdown 格式检查指南
本文档定义了本博客 Markdown 文档的格式检查标准,专注于确保文档符合 Hexo 规范和 Markdown 语法要求。
📋 目录
Front Matter 规范
标准格式
1 |
|
字段说明
| 字段 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
layout |
string | 是 | 布局类型 | post |
title |
string | 是 | 文章标题 | Java 并发编程实战 |
date |
string | 是 | 发布日期 | 2025-01-09 14:30:00 +0800 |
categories |
array | 是 | 分类(数组格式) | [tech, backend] |
tags |
array | 是 | 标签(数组格式) | [Java, 并发, 多线程] |
description |
string | 否 | 文章描述 | 深入理解 Java 并发编程 |
toc |
boolean | 否 | 是否显示目录 | true |
日期格式
标准格式:YYYY-MM-DD HH:mm:ss +0800
1 | date: 2025-01-09 14:30:00 +0800 |
错误格式:
- ❌
date: 2025-01-09(缺少时间部分) - ❌
date: 2025-01-09 14:30:00(缺少时区) - ❌
date: 2025/01/09(错误的分隔符)
标准格式(数组):
1 | categories: [设计模式] |
错误格式(列表):
1 | categories: |
代码规范
代码块格式
标准格式:
1 | ```语言 |
必须包含的语言标识
| 类型 | 语言标识 |
|---|---|
| Java | java |
| Python | python |
| Bash | bash |
| YAML | yaml |
| JSON | json |
| Text/模板 | text |
| Markdown | markdown |
| SQL | sql |
代码注释规范
Java 代码注释:
1 | /** |
Python 代码注释:
1 | def method(param: str) -> str: |
代码规范要求
- ✅ 代码块必须有语言标识
- ✅ 代码必须完整可运行
- ✅ 包含注释说明关键逻辑
- ✅ 提供预期输出或运行结果
- ✅ 避免外部依赖,或明确说明依赖
格式检查清单
Front Matter 检查
-
layout: post存在且正确 -
title存在且不为空 -
date格式为YYYY-MM-DD HH:mm:ss +0800 -
categories使用数组格式[分类] -
tags使用数组格式[tag1, tag2] -
description存在(推荐) - Front Matter 以
---开始和结束
Markdown 语法检查
- 标题层级正确(## → ### → ####)
- 列表格式正确(
-或*后跟空格) - 代码块有语言标识
- 链接格式正确
[文本](URL) - 图片格式正确
 - 表格对齐正确
- 分隔线使用
---(三个减号)
文件命名检查
- 文件名格式为
YYYY-MM-DD-{kebab-title}.md - 日期部分正确(YYYY-MM-DD)
- 标题部分使用 kebab-case(小写字母和连字符)
- 文件名与 Front Matter 中的 date 一致
内容格式检查
- 中文和英文之间有空格
- 标点符号使用正确(中文使用中文标点)
- emoji 使用合理,不过度
- 表格对齐正确
- 代码块缩进正确
- 列表项格式统一
常见格式错误
错误 1:Front Matter 格式错误
错误:
1 | categories: |
正确:
1 | categories: [设计模式] |
错误 2:日期格式不完整
错误:
1 | date: 2025-01-09 |
正确:
1 | date: 2025-01-09 00:00:00 +0800 |
错误 3:代码块缺少语言标识
错误:
1 | ``` |
正确:
1 | ```java |
错误 4:文件名与日期不一致
错误:
- 文件名:
2025-01-09-article.md - Front Matter:
date: 2024-12-25 00:00:00 +0800
正确:
- 文件名:
2025-01-09-article.md - Front Matter:
date: 2025-01-09 00:00:00 +0800
错误 5:标题层级跳跃
错误:
1 | ## 一级标题 |
正确:
1 | ## 一级标题 |
自动化检查
使用脚本检查格式
1 | # 检查 Front Matter 格式 |
Python 检查脚本
1 | #!/usr/bin/env python3 |
快速修复命令
批量修复 Front Matter 格式
使用之前创建的 fix-front-matter.py 脚本:
1 | python3 fix-front-matter.py |
手动修复示例
修复 categories 和 tags:
1 | # 使用 sed 批量替换(谨慎使用) |
相关文档
- Markdown 文档优化指南 - 内容优化标准
更新记录
最后更新:2025-01-09