在文件夹（myFolder）中提交图像（image.png），并在README.md中添加以下行：

![可选文本]（../master/myFolder/image.png）

在我的例子中，我想在Github上显示打印屏幕，但也在NPM上显示。尽管使用相对路径在Github内部有效，但在Github之外却无法正常工作。基本上，即使我也将项目推到了NPM（它只是使用了相同的readme.md），图像也从未显示。

我尝试了几种方法，最后这对我有用：


我现在可以在NPM或任何其他我可以发布我的包的地方正确地看到我的图像。

在最新的Github中，我尝试了以上所有方法，但未能在自述文件页面上显示图像。如果是公共回购，我发现最好的方法是对master或main分支使用githubpages，然后引用自述文件中的链接。

步骤：

在您的存储库中，转到“代码和自动化”下的设置->选择页选择回购的来源和分支，然后单击保存

现在您的repo应该托管在（https://*username*.github.io/*repone*/）上

现在，您可以通过

![Preview Image](https://*username*.github.io/*reponame*/images/logo.PNG)

你可以这样做：

git checkout --orphan assets
cp /where/image/currently/located/on/machine/diagram.png .
git add .
git commit -m 'Added diagram'
git push -u origin assets

然后，您可以在README文件中引用它，如下所示：

![diagram]（diagram.png）

这就行了！！

注意标记中的文件名大写，将PNG文件放入根目录，并链接到没有任何路径的文件名：

![Screenshot](screenshot.png)

许多张贴的解决方案都不完整或不合我的口味。

像imgur这样的外部CDN为该链添加了另一个工具。无聊的。在问题跟踪程序中创建虚拟问题是一种黑客行为。它会造成混乱，让用户感到困惑。将此解决方案迁移到fork或脱离GitHub是一件痛苦的事。使用gh-pages分支会使URL变得脆弱。另一个在维护gh页面的项目中工作的人可能不知道一些外部信息，这取决于这些图像的路径。gh-pages分支在GitHub上有一个特殊的行为，这对于托管CDN图像是不必要的。在版本控制中跟踪资产是一件好事。随着项目的发展和变化，管理和跟踪多个用户的变化是一种更可持续的方式。如果图像适用于软件的特定版本，则最好链接不可变图像。这样，如果稍后更新图像以反映软件的更改，任何阅读该版本自述文件的人都会找到正确的图像。

受这一要点启发，我的首选解决方案是使用带有特定修订永久链接的资产分支。

git checkout --orphan assets
git reset --hard
cp /path/to/cat.png .
git add .
git commit -m 'Added cat picture'
git push -u origin assets
git rev-parse HEAD  # Print the SHA, which is optional, you'll see below.

构造一个“永久链接”到图像的这个版本，并将其包装在Markdown中。

然而，手动查找提交SHA是不方便的，因此，作为快捷键，按Y键可以永久链接到特定提交中的文件，正如这个help.github页面所说的那样。

要始终显示资产分支上的最新图像，请使用blob URL：

https://github.com/github/{repository}/blob/assets/cat.png 

（从同一个GitHub帮助页面，文件视图显示分支上的最新版本）