跳到主要内容

博客编写示例:从元信息到运维记录

阅读需 3 分钟

这是一篇可复制的博客写作示例。博客适合记录运维实践、故障复盘和学习心得;系统化的技术手册可以放在 docs 目录中。

文件应该放在哪里​

文章放在项目根目录的 blog/ 下,也可以按主题建立子目录,例如 blog/containers/docker-inspection.md。使用 .md 或 .mdx 文件,开头写 YAML 元信息,后面写 Markdown 正文。

目录用于整理源文件,不会自动成为 Navbar 分类。本文设置了 slug: blog-writing-example,对应地址是 /blog/blog-writing-example。复制本文件后,请修改标题、日期、摘要和 slug,避免地址重复。

文章元信息​

---
slug: docker-inspection
title: Docker 日常巡检记录
date: 2026-10-21
authors: ops
tags: [Docker, 运维]
keywords: [Docker, 容器, 巡检]
description: 记录 Docker 容器状态、资源占用和日志的日常检查方法。
---
字段本站写作建议
title明确填写文章标题,正文从二级标题开始即可。
date明确填写发布日期,使用 YYYY-MM-DD,便于排序和归档。
slug建议填写唯一的英文短路径,文件改名后也能保持文章地址。
authors使用 blog/authors.yml 中的作者键;当前示例为 ops。
tags用数组填写分类标签,供标签页聚合文章。
keywords可选,填写与文章相关的关键词。
description建议填写简短描述,用于页面元信息。
image可选,填写已存在的封面图片路径或有效 URL。
sticky本模板扩展字段,可选数字;数值越大排序越靠前,省略时按 0 处理。
draft可选,设为 true 时用于草稿,生产构建不发布。

这些字段不要求全部填写。本站建议显式填写上面示例中的字段,避免依赖文件名推断标题或日期。YAML 使用空格缩进;包含特殊字符的标题或描述可用引号包裹。

authors.yml 目前使用“容器运维工程师”作为显示名称,可以自行改成昵称,并按需添加个人主页或头像。

首页与置顶​

博客插件沿用 Docusaurus 的文章处理,在此基础上按 sticky 值降序排列,并将前 10 篇文章提供给首页。需要置顶时,可在元信息中添加 sticky: 1;日常文章可以省略。date 用于发布时间和默认时间排序。

列表摘要​

在开头写一至两段摘要,再插入以下标记。标记前的内容用于博客列表摘要,完整正文仍会显示:

{/* truncate */}

description 与列表摘要不是同一个用途,建议同时填写描述和截断标记。

运维文章正文示例​

背景与目标​

记录操作原因、预期结果、适用版本和环境。示例目标是查看 Docker 容器的运行状态,不代表已经对实际环境执行操作。

环境与前置条件​

  • 环境:填写测试或生产环境。
  • 版本:填写 Docker 和操作系统版本。
  • 权限:确认具备访问目标 Docker 服务的权限。
  • 变更窗口:涉及变更时填写时间和影响范围。

检查步骤​

# 查看容器及其状态
docker ps -a

# 查看一次资源占用快照
docker stats --no-stream

在命令后记录预期输出、实际结果和异常判断依据。日志中如有密码、令牌或内部地址,发布前先处理敏感信息。

验证与回滚​

  • 验证:记录服务状态、监控指标和业务检查结果。
  • 回滚:若涉及配置变更,写明恢复步骤和验证方法。
  • 本例仅展示查询命令,无需回滚;实际操作请按影响填写。

Admonitions 提示框​

采用 Docusaurus 标准语法,类型后可用方括号设置标题,正文与冒号标记之间保留空行:

:::tip[操作建议]

先在测试环境验证,再执行生产变更。

:::
操作建议

先在测试环境验证,再执行生产变更。

变更影响

执行重启、清理或升级前,确认业务影响、备份和回滚方案。

常用类型包括 note、tip、info、warning、danger。

图片与链接​

本地图片放在 static/ 下,引用时省略 static。下面是语法示例,需要先放入实际图片再使用:

![容器巡检截图](/img/blog/docker-inspection.png)

[Docker 官方文档](https://docs.docker.com/)

Markdown 可以直接写链接、表格、列表和代码块;如需使用 React 组件,再考虑 MDX 和对应的组件导入。

发布前检查​

  • 修改 slug、title、date、description 和标签。
  • 确认 authors 能在作者配置中找到。
  • 保留一处摘要截断标记,检查正文和图片链接。
  • 删除示例说明、占位内容和敏感信息。
  • 运行 pnpm dev 查看文章与博客列表。
  • 结束开发服务后运行 pnpm build,检查构建结果。