写作规范

写作规范

概述

博客文章的写作并不是一次性的工作，因为文章很有可能会进行迁移以及发布到不同的平台。现在的平台基本都可以支持 Markdown 格式的写作，因此具备良好的 Markdown 写作规范可以便于后续的迁移和发布工作。

文字写作规范

安装 Visual Studio Code 插件：AutoCorrect，可以自动纠正一些格式错误。

分类与标签规范

categories：技术、折腾、小说、笔记、随笔

tags：

• 技术 / 折腾类：linux, nginx, docker, podman, nas, 群晖, 阿里云, 腾讯云, 云计算, ecs, 自建服务, 建站, wordpress, hugo, 博客, 网络, 安全组, ssl, 反向代理, 数据库, mysql, mariadb, php, python, shell, 运维, 命令行, 部署, 踩坑, 性能优化
• 知识分享 / 学习类：教程, 入门, 原理, 实践, 读书笔记, 学习方法, 知识管理, 效率工具, 思维导图, 笔记方法, 总结, 复盘, 科普
• 创作 / 个人类：短篇, 长篇, 科幻, 悬疑, 奇幻, 随笔, 思考, 职场, 吐槽, 生活, 感悟, 记录，爱情

标题与段落规范

• 层级清晰，避免跳级使用
• 末尾不添加标点符号
• 与内容之间保留一行空行
• 中英文混排时，中英文之间添加空格
• 嵌套列表使用 4 个空格缩进
• 列表项与内容之间保持一致的缩进

链接规范

• 内链：[文章标题](./相关文章.md)
• 外链：[链接文本](https://example.com "可选的title")

表格写作规范

格式与对齐

| 列标题 1 | 列标题 2 | 列标题 3 |
| -------- | -------- | -------- |
| 内容 1   | 内容 2   | 内容 3   |
| 内容 4   | 内容 5   | 内容 6   |

• 表格内容避免包含复杂的 Markdown 语法
• 设计代码、命令、变量、函数等内容时，需要使用`括起来`

代码写作规范

• 代码、命令、变量、函数使用反引号：function()
• 代码块需要表示代码语言，终端语言使用 bash
• 关键代码段应添加注释，注释应简洁明了，解释代码意图

图片命名规范

文件命名与存放

• 命名格式为文章主题 + 详细描述图片内容：OpenWRT_openwrt上防火墙的使用方式.png。强调：由于 halo 图床放置在同一文件夹下，因此绝对不能重复命名图片
• 避免使用空格和特殊字符
• 图片统一存放在文章文件夹下
• 图片全部不添加描述信息（通过命名描述）
• 尽量使用 png 格式

示例：![](OpenWRT_openwrt上防火墙的使用方式.png)

摘要与首页预览规范

首页折叠标记

首页预览由两部分组成：摘要部分（{{ .Summary }}）和折叠段部分（超过长度限制的内容，默认截断并附带「阅读全文」按钮）。摘要过长会导致首页被单篇文章撑爆。

• 每篇文章必须手动插入摘要分割标记 `

这是文章的导语，会完整显示在首页预览中。

<!--more-->

## 正文标题