GitHub：如何在README.md中嵌入同目录下的Python代码文件？

为什么<object>/<embed>/<iframe>无效 #

GitHub出于安全与页面性能考量，限制了这类HTML嵌入标签在README中的使用，所以这些方法无论用raw URL还是本地路径都无法生效，不用再尝试。

可行方案 #

• 直接用代码块粘贴（最推荐）
  把Python文件里的代码复制到README.md中，用三个反引号包裹并指定语言为python，会自动生成语法高亮：

  # 替换为你的Python代码
  def demo():
      print("This is embedded code")
  

  优势：加载稳定，无外部依赖，所有访问者能直接看到完整代码。

• 添加相对链接指向原文件
  如果代码过长不想复制，可以在README里加相对链接引导用户查看原文件：
  [查看完整Python代码](./your_script.py)
  点击链接会直接跳转到GitHub上的对应Python文件页面。

• 用GitHub Actions自动同步（适合实时更新需求）
  若需要Python文件更新时自动同步到README，可通过GitHub Actions实现：

  1. 在README中预留占位标记，比如<!-- PYTHON-CODE-INSERT-HERE -->
  2. 编写脚本读取Python文件内容，将其转换为带语法高亮的代码块，替换上述占位
  3. 配置GitHub Actions触发条件（如代码推送），自动执行脚本并提交README更新

内容的提问来源于stack exchange，提问作者MiKi