为了保证博客内容的排版整洁、风格统一以及良好的阅读体验,特制定本写作规范。
一、标题规范
1. 标题层级
- 不要使用一级标题 (
#):Hugo 会自动将 Frontmatter 中的title渲染为页面的一级标题。正文内容应从 二级标题 (##) 开始。 - 层级递进:请遵循
##->###->####的层级结构,不要跳级(例如从##直接跳到####)。
正确示例:
## 一、背景介绍
### 1.1 问题描述
#### 1.1.1 详细日志
错误示例:
# 背景介绍 (不要在正文中用一级标题)
### 1.1 问题描述 (跳过了二级标题)
2. 标题样式
- 不要在标题中使用粗体:标题默认即为粗体,不要画蛇添足。
- ✅
## 核心概念 - ❌
## **核心概念**
- ✅
- 简洁明了:标题应简练概括本节内容,尽量避免长句。
二、文本排版
1. 段落与换行
- 段落间距:Markdown 中段落之间请保留一个空行。
- 中西文混排:建议在中文与英文、中文与数字之间添加 空格,以增加可读性(虽然不是强制,但强烈推荐)。
- ✅ 学习 Hugo 的过程很有趣。
- ❌ 学习Hugo的过程很有趣。
2. 强调语法
- 粗体 (
**text**):用于强调关键概念或重点结论,不要滥用。 - 行内代码 (
`text`):用于标记简短的代码片段、文件名、路径、配置项或专有名词。- ✅ 请修改
config.yml文件。 - ❌ 请修改 config.yml 文件。
- ✅ 请修改
3. 引用块
使用 > 引用外部资料、名言或需要特别注意提示的内容。
这是一个引用示例。
引用块也可以包含分段。
三、代码块规范
- 指定语言:所有的代码块必须指定语言标识符,以便语法高亮生效。
正确示例:
``javascript console.log("Hello"); ``
错误示例:
`` console.log("Hello"); ``
四、Frontmatter 规范
每篇文章的开头必须包含以下元信息:
---
title: "文章标题"
date: 2026-02-09T12:00:00+08:00
lastmod: 2026-02-09T12:00:00+08:00
author: ["GopherDing"]
tags:
- 标签1
- 标签2
categories:
- 分类
description: "一句话描述文章内容"
draft: false
showToc: true
---
五、图片与资源
- 图片存放:建议文章相关的图片存放在
static/img目录下,按分类或文章名归档。 - 图片引用:使用 Markdown 语法,并填写
alt文本以便 SEO。
六、其他建议
- 列表使用:有序列表用于步骤说明,无序列表用于并列观点。
- 避免 emoji 滥用:正文中尽量少用 emoji,保持专业感(除非是轻松的生活类文章)。
- 检查链接:发布前请检查所有超链接是否有效。