github-readme-writinglisted

# GitHub README Writing ## 文件导航 | 序号 | 文件内容概览 | 关键词 | 触发时机 | 文件路径 | | --- | --- | --- | --- | --- | | 1 | 规定 GitHub README 的整体信息架构和视觉组件，覆盖居中标题、badge、目录导航、teaser、highlights 表格、news 折叠、Mermaid、项目结构树、Quick Start、联系方式、citation、star history 和图片懒加载。 | README structure、centered title、badge、navigation、teaser、highlights table、news、`details`、Mermaid、project tree、Quick Start、citation、star history、lazy image、emoji | 触发本 skill 后默认读取；新建 README 前；重构 README 首页结构前；增加 news/highlights/demo/quick start/citation/star history 前；检查 README 是否像项目主页而不是文档清单时读取 | `SKILL.md` | | 2 | 记录 README 和 GitHub Markdown 中公式稳定渲染的写法，覆盖 `math` 围栏、`$$` 风险、`x_{<t}` 替代、高风险宏、表格内公式、OCR 公式清理和渲染检查命令。 | GitHub math、KaTeX、`math` fence、`$$`、inline math、`\operatorname`、`\mathrm`、`x_{<t}`、`\mid`、Markdown table、OCR formula、`grep` check | README 或 GitHub notes 中写长公式/多行公式前；表格里需要表达变量或条件概率前；从 PDF/OCR 粘贴公式后；出现 Unable to render rich display 或 KaTeX 报错时必须读取 | [references/github-math-rendering.md](references/github-math-rendering.md) | ## 核心原则 - README 要像项目主页：第一屏让读者知道项目名、定位、入口、亮点和视觉印象。 - 严格采用 ResearchClawBench 风格：居中标题、居中 badge、短 tagline、导航链接、teaser 图、highlights 表格、news 前置、Mermaid、项目结构、quick start、community、citation、star history。 - 不要写成纯文档清单。README 应该有视觉层次、表格、图、流程图、结构树、可复制命令和明确入口。 - 可以适度使用 emoji 让 README 更活泼，但 emoji 应服务导航和语义，不要让每行都变成装饰。 - 不编造 badge、指标、论文、license、star、dataset、demo、leaderboard 或 citation。信息未知时使用占位符。 - 对外 README 不写 secret、内部路径、私有 token、未公开服务地址或不可访问链接。 ## 推荐结构 按这个顺序组织： 1. Top anchor and centered title。 2. Centered badg