• 日期:2026-08-29
  • 项目:codex-notes(仓库:codex-workspaces/codex-notes)
  • 涉及组件:README.md、easyimage / typecho troubleshooting 笔记
  • 状态:已完成

背景

codex-notes 是部署与运维笔记仓库。README 原先只包含目录结构约定,本轮补充「笔记格式约定」小节,统一笔记的书写格式。

完成内容

  1. README.md 新增「笔记格式约定」小节,确立以下约定:

    • .md 文件第 1 行为该文章分类,第 2 行为该文章的标签(多个标签用英文逗号分隔),随后空一行再写标题与正文。
    • 每篇笔记在开头的元信息列表(日期、项目、涉及组件、状态)之后、正文之前,加一行 <!--more--> 作为摘要分隔符。
    • 故障排查类笔记在 ## 根因 段落结束后,追加 ## 注意事项 段落。
    • 其余段落按实际情况使用 ## 现象## 排查过程## 修复## 验证方法 等标题组织。
  2. 目录结构新增 meta(元笔记/规范)类别,用于存放关于笔记仓库本身的笔记,本笔记即首篇。

当前笔记约定(速查)

位置约定
第 1 行文章分类
第 2 行文章标签(英文逗号分隔)
元信息后、正文前<!--more--> 摘要分隔符
## 根因## 注意事项(记录踩坑点、维护提醒、未完成事项)
其他段落## 现象## 排查过程## 修复## 验证方法 按需使用

注意事项

  • 现有两篇笔记(easyimage、typecho)尚未按新约定统一:均缺分类/标签行和 <!--more-->,easyimage 一篇还缺 ## 注意事项,typecho 的注意事项位于末尾而非根因之后;后续可一次性补齐。
  • 本环境 apply_patch 因 bwrap 沙箱故障无法写入文件,本次编辑改用带提权的 Python 脚本完成;若沙箱恢复,可继续使用 apply_patch

标签: codex-notes, readme, markdown, conventions

添加新评论