如何在github markdown中嵌入来自repo的代码？

Question

有没有办法在Githubs markdown中嵌入文件内容(来自项目仓库)？

我有一个代码示例,并希望将其嵌入到项目自述文件中.

Answer 1

@Petros 的答案（仍然）是正确的，但是我对此感到非常恼火，以至于我创建了一个工具来自动复制并使自述文件与源文件保持同步 - https://github.com/zakhenry/embedme

接受的答案中的示例用法

将注释插入代码栅栏

```rb
# path/to/your/file.rb
```

运行npx embedme README.md（假设您已安装 Nodejs）

自述文件将就地编写，文件内容在您的评论之后

```rb
# path/to/your/file.rb
class MyClass
end
```

请注意，由于注释仍然存在，您可以愉快地重新运行npx embedme README.md，它不会进行任何更改。

如果您有 CI，您还可以运行npx embedme --verify README.mdwhich 将1在检测到差异时返回（这意味着在没有更新自述文件的情况下更新了源）。

Answer 2

你目前不能这样做。您必须复制您的代码示例并将其粘贴在自述文件中的三个勾号之间。下面是一个例子：

``` 红宝石
我的课堂
结尾
``

这当然是静态的，您必须在代码更改时手动更新它。

Answer 3

Github 现在支持在 Markdown 文件中渲染永久链接。示例 - https://github.com/stevemar/code-reference-in-readme

信用： https: //www.stevemar.net/github-code-in-readme/