博客文章质量标准
本文档定义了本博客文章的质量标准，确保所有文章具有一致的结构、格式和质量。
文章结构要求
Section titled “文章结构要求”1. 前言部分 (Frontmatter)
Section titled “1. 前言部分 (Frontmatter)”每篇文章必须包含以下 frontmatter 字段：
---title: 文章标题（简洁明了）description: 文章描述（50-100字，概括主要内容）---可选字段：
sidebar_label：侧边栏显示的标签sidebar_position：侧边栏中的位置tags：标签列表author：作者date：发布日期
2. 文章内容结构
Section titled “2. 文章内容结构”每篇文章应包含以下部分：
2.1 引言
Section titled “2.1 引言”- 介绍文章主题
- 说明文章目标
- 概述主要内容
2.2 主体内容
Section titled “2.2 主体内容”- 使用清晰的标题层级（H2、H3、H4）
- 代码示例使用语法高亮
- 重要信息使用警告框（:::caution）或提示框（:::tip）
2.3 总结
Section titled “2.3 总结”- 总结关键点
- 提供进一步阅读的链接
- 鼓励用户实践
1. 语言风格
Section titled “1. 语言风格”- 一致性：整篇文章使用同一种语言（中文或英文）
- 简洁明了：避免冗长复杂的句子
- 专业准确：技术术语使用准确
2. 代码示例
Section titled “2. 代码示例”- 所有代码块必须指定语言标识符
- 复杂命令应添加注释说明
- 提供跨平台命令示例（Linux/macOS/Windows）
3. 链接和引用
Section titled “3. 链接和引用”- 外部链接使用 Markdown 格式
- 引用官方文档时注明来源
- 避免过多的外部链接
4. 格式要求
Section titled “4. 格式要求”- 使用中文标点符号（中文文章）
- 代码块使用三个反引号包裹
- 列表使用一致的缩进
1. 跨平台兼容性
Section titled “1. 跨平台兼容性”- 技术教程必须提供 Linux、macOS 和 Windows 三个平台的命令
- Windows 命令使用 PowerShell
- 为不同 Shell 提供对应的配置方法
2. Starlight 组件使用
Section titled “2. Starlight 组件使用”:::tip- 提供额外上下文或解释设计理念:::caution- 警告用户可能的数据丢失或不可逆操作:::note- 补充说明
3. 代码块规范
Section titled “3. 代码块规范”- 为代码块添加语言标识符（bash、powershell、json、toml 等）
- 为复杂命令添加注释说明
- 检查中文引号并修正为英文引号
质量检查清单
Section titled “质量检查清单”在发布文章前，请检查以下项目：
- 是否包含完整的 frontmatter
- 标题层级是否清晰
- 是否有引言和总结部分
- 技术内容是否准确
- 代码示例是否可运行
- 链接是否有效
- 是否包含跨平台命令
- 语言是否一致
- 标点符号是否正确
- 代码块是否有语法高亮
- 警告框和提示框使用是否正确
- 文章是否易于理解
- 是否有冗余内容
- 排版是否清晰
本博客文章分为以下几类：
- 教程类：详细介绍如何完成特定任务
- 参考类：提供命令或配置的快速参考
- 经验总结类：分享实践经验或问题解决方案
- 工具介绍类：介绍新工具或技术
参考以下文章作为写作范例：
- 2026-03-13：初始版本创建