如何在GitHub的README.md文件中添加图片

如何在GitHub的README.md文件中添加图片

GitHub是一个流行的代码仓库托管和管理平台。在GitHub上,一个良好文档化的项目必备的要素之一就是一个清晰和信息丰富的README文件。通常,您会希望在README中包含图片来说明您的项目,展示截图或添加图表。在本文中,我们将向您展示如何在GitHub的README.md文件中添加图片,既可以使用第三方托管服务,也可以不使用外部托管服务。

目录

问题:需要在README.md中添加图片 #

当您想要在GitHub的README文件中添加图片时,最常见的建议是将图片托管在第三方网站(如Imgur、Dropbox或个人网站)上,然后在您的README.md文件中指定图片路径。尽管这种方法很有效,但并不适合所有用户,特别是那些不愿意依赖外部托管服务的用户。

解决方案:GitHub的存储库上传 #

GitHub本身提供了解决此问题的方法,允许您上传图片至存储库。 直接将图像上传到您的存储库。这种方法确保您的图像托管在GitHub存储库中,使其更加自包含,并避免对第三方服务的依赖。

以下是您可以使用GitHub的存储库上传功能将图像添加到您的README.md文件的步骤:

第1步:上传图像 #

  1. 在您的GitHub存储库中,导航到您想要上传图像的位置。您可以为这些图像创建一个新文件夹或使用现有文件夹。
  2. 单击“添加文件”按钮,然后选择“上传文件”。
  3. 现在,您可以将图像文件拖放到此处,或使用文件选择器从计算机中选择它们。
  4. 在上传图像后,您将在存储库中看到它们列出。请确保提供有意义的文件名以保持组织。

第2步:在README.md中引用图像 #

在您的README.md文件中,您可以使用相对路径引用上传的图像。例如,如果您将图像上传到一个文件夹中,您可以使用以下方式引用它: 在images命名的文件中,您可以使用以下Markdown代码来显示图像:

![GitHub图像](/images/your-image.png)

your-image.png替换为您的图像的实际文件名。

步骤3:提交和推送 #

在将图像引用添加到您的README.md文件后,确保提交更改并将其推送到您的GitHub存储库。这将使其他人可以查看更改和图像。

使用外部托管服务 #

尽管GitHub的存储库上传是在README.md文件中包含图像的便捷方式,但对于非常大或数量众多的图像来说,可能并不是最佳解决方案。在这种情况下,外部托管服务仍然可以很有用。

您可以按照传统的方法将图像托管在第三方网站上,并在您的README.md文件中指定它们的URL。当您不想通过许多图像增加存储库的大小时,这是一个可行的选项。

以下是如何引用托管在外部网站上的图像的示例。 ## 存储库/分支中图像的原始GitHub URL

如果您需要引用位于单独存储库中的图像,GitHub具有可用于直接引用公共存储库中的图像文件的“原始”URL。

以下是公共GitHub存储库中图像的“原始”URL示例:

https://raw.githubusercontent.com/crpietschmann/jHtmlArea/master/img/nuget-package-install.png

您可以看到“原始”URL的格式如下:

https://raw.githubusercontent.com/{用户名}/{项目}/{分支}/{存储库中的文件路径}

“原始”URL格式中的占位符如下:

  • {用户名} - 托管存储库的GitHub用户名。
  • {项目} - GitHub项目/存储库的名称。
  • {分支} - 存储库/分支中包含文件的Git分支。
  • {存储库中的文件路径} - 完整的文件路径。 在存储库分支中的图像文件中,您想要引用的内容。在上面的示例中,这是img/nuget-package-install.png

然后,存储库中图像的“原始” GitHub URL 可以与README.md文件中的其他外部托管图像一样使用:

![Raw GitHub Image](https://raw.githubusercontent.com/crpietschmann/jHtmlArea/master/img/nuget-package-install.png)

结论 #

在本文中,我们向您展示了如何在GitHub的README.md文件中添加图像。GitHub的存储库上传功能为在存储库内直接包含图像提供了一种便捷的方法,使其自包含,并消除了对外部托管服务的需求。然而,对于非常大或数量众多的图像,使用外部托管服务是一种实际的选择。

通过按照这些步骤,您可以使您的GitHub项目在视觉上更具吸引力和信息性,增强整体用户体验。无论您选择将图像上传到您的项目中还是使用外部托管服务,都将使您的项目更加丰富多彩。 关于作者