Github: 如何将一个 gist 嵌入到 README.md？

如果你是一名前端开发者，那么你可能有自己的 Github 仓库来展示你的作品和技能。在 README.md 文件中添加代码片段可以很好地展示你的项目。但是，如果你想要嵌入一个 gist（一个 Github 上的代码片段），该怎么办呢？

本文将介绍如何将一个 gist 嵌入到你的 README.md 文件中，并提供相关示例代码以加深你的理解。

步骤

步骤 1：创建一个 gist

首先，你需要创建一个 gist。打开 gist.github.com 并点击 New gist 按钮。在页面上，你可以输入代码并添加文件名和描述，以便其他人了解这个 gist 的用途。完成后，点击 Create secret gist 或 Create public gist。

步骤 2：获取 gist 的 ID

当你创建了一个 gist 后，你会看到页面的 URL 包含一个字符长的 ID（例如，https://gist.github.com/username/1234567890abcdefg）。复制该 ID，因为我们稍后需要使用它。

步骤 3：嵌入 gist 到 README.md 中

现在，你可以将你的 gist 嵌入到 README.md 文件中了。使用以下语法：

<!-- Gist 描述 -->
<script src="https://gist.github.com/用户名/ID.js"></script>

使用该语法时，请更改 用户名 为你的 Github 用户名，ID 为你复制的 gist ID。

以下是一个示例代码块，展示如何将一个 gist 嵌入到 README.md 文件中：

这是我的代码片段：

<!-- Here's my code snippet: -->
<script src="https://gist.github.com/yourusername/1234567890abcdefg.js"></script>

指导意义

将 gist 嵌入到 README.md 文件中可以提高项目的可读性和易用性。此外，这还有助于其他开发者了解您的项目，并在需要时从您的代码中获取灵感。

在嵌入代码片段之前，确保你已经公开了你的 gist。如果你的 gist 是私有的，则无法在 README.md 文件中嵌入它们。

结论

本文介绍了如何将一个 gist 嵌入到 README.md 文件中。通过遵循上述步骤并使用给定的语法，你可以在你的 Github 仓库中方便地展示你的代码和技能。

希望这篇文章对你有所帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/606f0fb62d2a29a3c1202e70