You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在GitHub README的Markdown中实现Git风格代码行着色?

在GitHub README中实现Git风格的代码行着色效果

要在GitHub的README文档里实现类似Git的代码行着色(新增行绿色、删除行红色),核心是利用GitHub Flavored Markdown(GFM)支持的diff语法高亮,具体操作如下:

1. 基础用法:使用diff代码块

在Markdown中创建代码块时,指定语言为diff,然后通过行首符号标记代码状态:

  • 行首加-:标记为删除行,GitHub会渲染为红色
  • 行首加+:标记为新增行,GitHub会渲染为绿色
  • 行首加空格或无特殊标记:标记为未修改行,保持默认代码颜色

示例代码

- import oldModule from './old-module.js';
+ import newModule from './new-module.js';

- const oldConfig = { timeout: 5000 };
+ const newConfig = { timeout: 10000, retry: 3 };

  function fetchData() {
-   return fetch('/api/old-endpoint', { timeout: oldConfig.timeout });
+   return fetch('/api/new-endpoint', { timeout: newConfig.timeout, retry: newConfig.retry });
  }

2. 效果展示

GitHub diff代码行着色示例

3. 实际使用场景参考

在sveltejs/kit的社区讨论中,开发者常使用这种方式展示代码变更,通过清晰的颜色区分,让读者快速定位新旧代码的差异,提升文档的可读性。

注意事项

  • 必须确保代码块开头为```diff,指定语言为diff才能触发着色效果
  • -和+必须在行首,前面不能有空格,否则无法被识别为删除/新增行
  • 未修改行可以在行首添加一个空格,和标记行形成视觉区分,让结构更清晰

内容的提问来源于stack exchange,提问作者user19485937

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.08.12 07:20:29