最近我加入了GitHub。我在那里主持了一些项目。

我需要在README文件中包含一些图像。我不知道该怎么做。

我搜索了一下,但得到的只是一些链接,告诉我“在web上托管图像并在README.md文件中指定图像路径”。

是否有任何方法可以在不在任何第三方网络托管服务上托管图像的情况下做到这一点?


当前回答

如果添加多个屏幕截图并希望使用表格数据对齐它们以提高可访问性,请考虑使用表格,如下所示:

如果markdown解析器支持它,您还可以将role=“presentation”WIA-ARIA属性添加到TABLE元素,并省略th标记。

其他回答

在新的Github UI中,这对我有用-

示例-在文件夹(myFolder)中提交image.png,并在README.md中添加以下行:

![Optional Text](../main/myFolder/image.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)

如果您想显示任何网站上托管的图像(假设url为“http://abc.def.com/folder/image.jpg”),那么在README.md文件中使用以下语法:![alt-text](<http://abc.def.com/folder/image.jpg>)

只需在浏览器中浏览图像(可以通过单击图像)。它可以是任何网站,包括你的或其他人的github托管图像。从浏览器地址栏中复制url,即要在上述语法中使用的“image_url”。


对于托管在您自己的github存储库中的图像,除了上述url格式之外,您还可以使用相对路径![alt-text](<path_relative_to_current_github_location/image.jpg>)如果图像与README.md文件位于同一文件夹中(相对路径url的特殊情况),则可以使用:![alt-text](<image.jpg>)


注意url周围的尖括号“<”和“>”。有时,这些是url工作所必需的。

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

我尝试了几种方法,最后这对我有用:

![预览](https://raw.githubusercontent.com/username/project/master/image-path/image.png)

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

尝试此标记:

![alt text](http://url/to/img.png)

我认为,如果图像存储在存储库中,您可以直接链接到原始版本的图像。即

![alt text](https://github.com/[username]/[reponame]/blob/[branch]/image.jpg?raw=true)