Claude Code til-review:审查 Markdown 技术笔记
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/til-review/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/til-review/`,把核对后的文件保存为 `.claude/skills/til-review/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/til-review`。
中文摘要
校对 TIL 技术笔记的命令、写法与 Markdown 格式,核对参考资料、README 索引和项目词表。
SKILL.md 中文导读
可复现示例
待审笔记 notes-07 使用 Markdown 二级标题“Compress a file”。正文已有示例命令“gzip -k notes.txt”,但没有参考资料章节,README.md 也没有相应的索引项。工作步骤
- 给出待审笔记,按项目的格式配置核对 Markdown 与命令示例。
- 核对参考资料、README 索引及词表,把缺项和诊断写进审查结果。
验收方法
审查结果列出 {referenceSection: missing, readmeEntry: missing},同时记录项目 Markdown 配置下的实际检查结果。
GitHub 原文 · 更新日期
适用环境
在 Claude Code 中打开 jonasbn/til 仓库,准备 markdownlint,以及仓库的 .markdownlint.json、README.md 和 .wordlist.txt。
常见问题
一定要直接修改笔记吗?
该技能主要用于指出问题。它会核对 README 链接和词表,并给出缺项和修改建议。