GitHub Readme.md标记文件数据-图像源的规范源问题
GitHub Readme.md标记文件是一种用于展示项目信息和说明文档的文件格式。它通常位于项目的根目录下，文件名为README.md。Readme.md文件支持使用Markdown语法来格式化文本，并可以添加图片、链接、代码片段等内容。
在GitHub上，Readme.md文件扮演着非常重要的角色，它可以帮助用户了解项目的功能、使用方法、贡献指南等信息，同时也是项目的门面，可以吸引更多的开发者和用户关注。
对于Readme.md文件中的图像源问题，可以指的是如何在文件中添加和管理图像资源。通常可以通过以下方式进行操作：
- 添加图像：可以将图像文件放置在项目的某个目录下，然后使用相对路径的方式在Readme.md中引用图像。例如：
 - 图像大小调整：可以使用HTML的img标签来调整图像的大小。例如：
<img src="./images/图像文件名.png" alt="图像名称" width="200" height="150" /> - 链接外部图像：可以直接使用外部图像的URL链接来在Readme.md中显示图像。例如：
需要注意的是，为了保证项目的可维护性和可访问性，建议在使用图像资源时遵循以下几点：
- 图像文件尺寸适中，避免过大而导致加载缓慢。
- 图像文件名要有描述性，易于理解和管理。
- 图像资源要遵循版权规定，尊重知识产权。
- 尽量使用可靠的图像存储和分发服务，以确保图像的可访问性和稳定性。
腾讯云提供了多种产品和服务，可以帮助开发者在云端部署和管理项目，同时也支持存储和分发图像资源。具体的产品和服务可以参考腾讯云官方文档：腾讯云产品与服务
注意：这里给出的是示例答案，实际情况可能因产品变更而有所不同，请根据实际情况和腾讯云官方文档进行确认。
相关·内容
2回答
我的存储库的GitHub页面是从自述文件中构建的，一切都很好，但是由于我向README.md添加了一些图像，页面变得一团糟。也许是因为我添加图像的方式？或者是一只小虫？这是README.md文件的乞求：
# Salty Engine
  时，它失败了。这有可能将这种格式嵌入到标记文件中吗？
浏览 1提问于2022-09-21得票数 0
1回答
如何在GitHub呈现的标记文档中包含外部文件中的表，这是一种优雅的方法吗？
非典雅的解决方案，我能想到：
包括它作为图像(这是真的很丑)
使用Rmarkdown并使用R打印表(默认情况下不会呈现)
只是想解释一下。我在我的git存储库中使用了一组README.md文件(由GitHub托管)，因此很明显可以在线浏览回购文件，因为GitHub会在每个子目录中自动呈现README.md文件。
我在算法上生成应该包括在这些文件中的汇总表。如果可以从外部文件中读取该表，将更加优雅，因为我不想编写将直接修改README.md文件的脚本。
浏览 2提问于2017-01-23得票数 3
回答已采纳
每次我将图片拖放到Github上的项目发布页面中，然后将链接复制到Readme.md文件。这通常是可行的，但如果我有一些更复杂的标签，那么图像将不会显示，相反，链接将显示。
这就是在中的样子：
这就是在Github(现场直播)上的样子：
请注意，MarkDown编辑器按预期显示图像：
浏览 1提问于2018-07-21得票数 3
回答已采纳
我想在README.md中插入表作为vscode扩展。我的代码如下：
* some title
| words | transform to | keepUpperCase is false | keepUpperCase is true |
|--------------------|--------------|------------------------|-----------------------|
| "XML HTTP request" | pascalCase | `XmlHttpRequest`
浏览 1提问于2019-02-13得票数 0
回答已采纳
检查显示有一个README.md文件和一个README.Rmd文件。
在.md文件中，它说
README.md是从README.Rmd生成的。请编辑那个文件
创建.Rmd文件非常容易，但是如何生成.md文件呢？它是在使用roxygen2，还是有一些终端命令(或者其他什么)？
浏览 0提问于2019-05-29得票数 9
回答已采纳
我已经创建了Cocoapod - RPUpdatingLabelFramework并添加了README.md文件。我在Readme.md文件中添加了一个指向图像(我的存储库的一部分)的链接(相对路径)。当我提交并将我的存储库推送到Github - raunakp/RPUpdatingLabel时，我可以在Github呈现的README.md文件中看到图像。 但是，我在Cocoapod呈现的README.md文件中看不到图像。 请在https://github.com/raunakp/RPUpdatingLabel/blob/master/README.md上检查我的README.md文件，并
浏览 10提问于2019-09-30得票数 0
2回答
我该怎么做呢？将以下代码放入会得到所需的输出
<div style="float: left"><img src="http://ompldr.org/vaDU5NQ/scrotter.png"/>
</div>
I'm trying not to, kid. Don't act so surprised, Your Highness. You weren't
on any mercy mission this time. Several transmissions were beamed to thi
浏览 0提问于2013-01-20得票数 26
回答已采纳
为什么我的create-react-app显示的是README.md，而不是index.html？
我已经运行了npm运行构建->纱线运行部署，多次检查文件结构，并阅读了大量的文档。找不到任何其他有相同问题的线程。
谢谢。
浏览 2提问于2017-11-17得票数 4
41回答
最近我加入了GitHub。我在那里主持了一些项目。
我需要在我的自述文件中包含一些图片。我不知道该怎么做。
我对此进行了搜索，但我得到的只是一些链接，这些链接告诉我“在web上托管图像并在README.md文件中指定图像路径”。
有没有办法做到这一点，而不托管任何第三方网络托管服务的图像？
浏览 87提问于2013-01-24得票数 3005
回答已采纳
我是一个开发人员，我需要许多截图放在readme.md文件中，在哪里存储或托管它？我发现有些人使用{路径}/{文件名}来托管他们的图像，并将它们链接到readme.md文件。如何将图片放在那里？？
浏览 26提问于2020-05-01得票数 14
1回答
我在GitHub上有一个GitHub包，即将提交给CRAN。到目前为止，该包已经有了一个广泛的README.md文档，其中显示：
包核心函数执行的示例，
包演示执行的示例，
一些基准结果。
对于GitHub用户来说，我认为当用户查看包的回购时，将这些东西放到README.md上比vignette更有吸引力。
当将包移动到CRAN时，我希望以一种小片段的形式提供与README.md中的内容基本相同的内容。
问:将几乎1-1的README.md复制成一个小片段，同时保持这两种状态，更新GitHub回购以获得这个小片段，然后以这样的方式提交给CRAN，这是一种正确的做法吗？或者:
浏览 0提问于2018-12-17得票数 5
回答已采纳
我已经为我正在工作的一个程序颁发了许可证。
我的问题是:在github目录中是否可以将文件(在我的情况下是：license.md)显示为readme.md？
浏览 3提问于2016-04-10得票数 1
回答已采纳
我有一个基本的React应用程序。没有后端。我想在github页面上设置它。我读了这篇文章两次。
这两次，Github Pages都会显示我的公共文件夹中的index.html文件，而不是README.md文件。这是该应用程序的文件目录的图像。有什么想法吗？
如果重要的话，下面是我在package.json中拥有的：
{
"name": "react-blog",
"version": "0.1.0",
"private": true,
"homepage": "htt
浏览 0提问于2017-10-06得票数 4
1回答
我有一个模块存储库，其中包含模块代码、一个README.md文件和存储在目录images/ (在README.md中使用相对链接链接到)的README.md文件中使用的图像。为了注册模块并将其上传到PyPI，我有两个文件setup.py和MANIFEST.in。如何才能使图像包含并出现在PyPI在线文档中(如假设的页面中所示)？
我目前拥有的MANIFEST.in和setup.py (在PyPI在线文档中不包含图像)如下：
MANIFEST.in
include LICENSE
include README.md
include images/*
include setup.py
includ
浏览 3提问于2016-01-27得票数 7
1回答
我想要的是一个JSON格式的一些行的列表(基本上像引号一样)。
如何从JSON文件中在Readme.md中显示随机行。
JSON文件的示例：
[
"Hello, world",
"How you doing?",
"Hello, folks",
"How are you?"
]
我只想在每次加载页面时，从列表中随机添加一个项目到Readme.md文件中。
浏览 1提问于2021-03-14得票数 0
回答已采纳
我注意到一些GitHub项目不仅有README文件，还有README.md文件。
这些文件之间有什么不同？我知道README也是项目存储库页面中的介绍性文本，但我不知道README.md是做什么的。
浏览 0提问于2011-12-28得票数 399
回答已采纳
有任何选项可以在具有usemap属性的readme.md文件中包含图像吗？
纯html将是
<img src="myimage.png" usemap="#mymap"/>
<map name="mymap">
<area coords="1,1,40,40" href="mylink.html"/>
</map>
我不能让它起作用有多种原因
usemap作为属性保留，但map块被删除。如果我没有弄错的话，这并不奇怪，因为html白名单上没有地图标签。
图
浏览 4提问于2017-09-11得票数 3
4回答
我在github上的readme.md中添加了一个图像引用。图片是肖像格式的照片，但是当我在github页面上看到它时，图片是旋转的。
我已经尝试克隆回购到一个新的位置，以确认图片确实仍然是肖像，如预期在回购。
Readme.md的图像部分：
Here is a picture of the hardware setup. 
这是
更新
现在我真的很困惑--我试图在中简化这个问题，但是这张图片没有像(最初)预期的那样旋转。
更新
我创建了一个。然后图片被旋转。
浏览 7提问于2013-10-17得票数 11
您好:我已经为我的存储库和GitHub页面创建了readme.md文件。但是当我创建h2/##或h3/##等格式的标题时，页面内锚点链接会自动创建。我尝试了不同的方法来格式化标题--例如##、、-但是我得到了相同的结果。它出现在每个标题中。这发生在存储库中的readme.md文件和那些转换为GitHub页面的文件中。我已经在chrome浏览器和edge浏览器上测试过了，它的行为是一样的。 # sample将创建标题和不需要的页面内链接 ## sample将创建标题和不需要的页面内链接 这是一个包含以下行为的页面：https://burrittresearch.com/ 我的目标是能够在不自动
浏览 26提问于2020-08-25得票数 1
10回答
我和几个人一起有一个项目，我们有一个README.md文件，其中有一堆GitHub风味的Markdown，呈现在我们的GitHub页面上。我们还设置了一个GitHub页面分支，它托管在GitHub组织的子域中，并在创建页面时使用简单地加载到我们的README.md文件中。但是，我注意到，当我更新我们的README.md文件时，它不会更新项目页面。相反，我们必须转到GitHub设置选项卡，重新创建项目页面，重新加载README.md文件。
另外，在阅读了关于在GitHub项目目录页上的文档文件之间工作的信息之后。我非常喜欢这个标记，因为它节省了大量的时间，无需为文档手工编写所有HTML。然而，我
浏览 13提问于2013-03-05得票数 81
回答已采纳
1回答
的底线：是否有一种方法可以在README.md文件中创建锚链接(内容表样式)，在NPM和GitHub中都能工作？
大家好，
我有一个README.md文件，它既在GitHub上，也在NPM上。在文件的顶部，有一个目录，它只是一个链接列表。每个链接都应该指向文件中的一个头。
在搜索和阅读了一些堆栈溢出答案之后，我尝试了以下操作：
[Overview](#overview) --但这导致NPM将我的所有链接指向我的GitHub。
我求助于硬编码链接，以便它们指向NPM上的适当锚，但显然这意味着任何人单击GitHub上的链接都将被重定向到NPM页面。
README.md文件可以在这里找到：
他在做广
浏览 3提问于2014-11-02得票数 2
我将一个.epub文件上传到GitHub存储库。我想在README.md文件中创建到这个文件的下载链接。
通过单击此链接，用户将能够直接下载该文件，而无需转到另一个页面并单击该页面上的“下载”按钮。
是否可以通过默认的README.md (markdown)文件来实现这一点？
浏览 5提问于2022-07-12得票数 0
回答已采纳
我可以很好地访问现有的文件。例如，在回购的根部检索README.md的内容是非常有效的：
https://api.github.com/repos/kevindecent/decent-salesforce/contents/README.md
但是，如果我在repo的根目录下创建一个名为'test.txt‘的新文件，当我试图像这样检索它时，我会得到一个“Not”错误：
https://api.github.com/repos/kevindecent/decent-salesforce/contents/test.txt
为什么我不能在回购系统的根部使用Github访问新创建的文件呢？
浏览 4提问于2022-01-28得票数 2
我在验证将修改Github repo根目录下的readme.md文件的.css文件时遇到问题。
我相信它是：
.github/github.css
但这似乎对Markdown没有任何影响。有没有人知道这是不正确的？
浏览 18提问于2018-08-22得票数 29
回答已采纳
3回答
有人知道dockerhub是如何管理自动构建存储库的描述的吗？
有一个很好的特性，就是将源存储库中的README.md作为存储库描述。实际上，存储库的描述并不总是来自主分支的最新README.md。这似乎是相当随机或相关的最新版本。
实例库：
/
Dockerfile
README.md
分支机构：
主控
标签：
V1.0
V1.1
V2.0
V2.1
现在的问题是:如果我将所有标记都放在Autobuild上，那么存储库描述中将显示哪个README.md是不可复制的。
它有什么窍门吗?还是有一个API可以用来设置描述？
我的愿望是总是显示
浏览 7提问于2016-01-27得票数 13
回答已采纳
我需要有一个相对链接到我的回购的根从标记文件。
(我需要它在任何叉子上工作)
因此，它似乎是提供一个指向根目录中的文件的链接的唯一方法：
the [Root](/README.md)
或
the [Root](../README.md)
(例如，如果位于/doc/README.md )
同时，我可以在不引用文件的情况下引用任何文件夹
the [Doc](/doc)
但是，如果我尝试将一个链接放到根文件夹：
the [real root](/)
the [real root](../)
我会有这样的链接
blob/master
不像
blob/master/doc
指404
因此，如果我不想在根
浏览 1提问于2016-11-04得票数 35
回答已采纳
我在驱动器中有图像，如何将其添加到Readme.md以便在自述文件中显示图像。我尝试过共享链接，但它不起作用。
浏览 0提问于2018-08-29得票数 32
回答已采纳
我有以下问题..。我为我的项目创建了一个，因为我不是一个网页开发人员，并且没有任何HTML或CSS方面的特殊技能，所以我通过一个可以从存储库设置中选择的生成了这个页面.
现在，我遇到的问题是，从模板生成的Jekyll页面和我的README.md没有显示预览图像。在我的README.md文件中，我用以下标记指定了图像：
|  |
|:--:|
| *Preview image of application* |
但是Jeky
浏览 0提问于2018-04-24得票数 0
回答已采纳
我正在为我的github项目编写.md格式的自述文件。有没有办法在提交到github之前测试我的readme.md文件是什么样子的？
浏览 4提问于2012-02-17得票数 294
回答已采纳
3回答
我经常对这样的问题感到困惑。我需要修改我的项目有两个原因：
发布源代码及其整个历史，使人们能够进入它，探索和利用它。
存档我的项目与它的整个历史，以便我将能够恢复，叉子等。
在我的项目中，基本上有两种类型的文件：
基本文件，原始源代码核心，src/*，README.md，configure.ac等，我需要他们为人们版本.
帮助我使用原始源代码核心的文件，如customCheckNBuildScripts/*、favoriteIDEConfiguration/*、absolutePaths/*、shortcuts/*、hooksILike/*等，我需要它们为我进行版本化。
哪个工作流将帮助我处理
浏览 0提问于2016-09-11得票数 7
回答已采纳
我有一个很窄的长图像，我想在GitHub上的README.md文件的右上角显示它。我已经尝试了几件事情来使它正确地对齐，目前我已经
<p align="right">
<img src="doc/subpagelist.png" />
</p>
这是因为图像是靠右对齐的，尽管这是没有用的，因为Markdown文件中图像下面的所有内容都显示在图像的底部，而不是图像的左侧。
有没有办法让文本在图像周围流动(而不去掉标题和段落)？
浏览 3提问于2013-09-29得票数 73
当我使用GitHub开始一个新项目时，我总是为同样的问题而苦苦挣扎。当我创建一个GitHub项目时，它已经预先填充了一些文件(.gitignore、LICENSE、README.md)，因此具有初始提交。我显式地选择添加这些项，这样我就不必关心自己编写它们了。
另一方面，当我开始一个新的Xcode项目时，它的工作方式非常相似: Xcode创建一些文件的初始提交。因此，当我试图提取我的GitHub代码库时，我总是要处理问题。
对此是否有正确的工作流程？
浏览 2提问于2017-05-09得票数 1
1回答
我希望在我的github README.md文件中的表格单元格中出现复选标记。问题是，:white_check_mark:不是以白色复选标记的形式出现，而是将原始文本保留在表中。
这是这张桌子的全部减价
| Property | Type | Null | Description |
| -------- | ---- | ---- | ----------- |
| subject | string | | Message subject |
| body_excerpt | string | | Short excerpt of the mess
浏览 0提问于2015-01-08得票数 4
回答已采纳
我正试图用Sveltekit创建一个个人网站，并希望将我的GitHub配置文件README.md作为页面中的一个组件。我试过mdsvex和其他人，但他们似乎只处理已经写入本地文件的减价。
例如，我想包括这样的内容：
<script>
import Markdown from 'some-library'
</script>
<Markdown src='https://raw.githubusercontent.com/myprofile/myprofile/main/README.md'/>
浏览 7提问于2022-10-31得票数 0
回答已采纳
2回答
我需要从我的计算机上的一个目录中发布一个Github存储库。
我添加、提交并推动了我想要从我的项目的根目录中发布的文件的主目录。我的意思是，我点击了“”按钮，并在我想要发布的存储库中的项目目录中键入了我的终端中的所有git命令。有关我使用的命令的列表，请参见下面标有“Code”的部分。
我在终端命令中没有看到错误。当我完成时，我在我的存储库中看到的都是README.md文件，而不是其他任何东西。
我试图在我的终端上检查我的登录名是否与目标存储库的Github用户名相匹配。但是我没有看到在终端上检查登录名的任何命令。
OS /config：在MacBook Air上使用OSX10.10.5 (
浏览 2提问于2015-10-20得票数 0
回答已采纳
2回答
我有一个带有GitHub文件的README.md回购。我的头部下面有一些，但它们是左对齐的，不是中心的.
<a href=""></a>
<a href=""></a>
<a href="">
- ERROR | [xcodebuild] JBMessage/JBMessage/JBMessage/JBMessage.m:237:39: error: incompatible block pointer types sending 'void (^)(NSUInteger, NSInteger, NSInteger)' to
浏览 2提问于2014-04-24得票数 1
回答已采纳
2回答
问题
是否有一种方法可以定义模式，以避免从git clone或git fetch上的git服务器中提取文件？这可以被称为“反向忽略”。
问题
我所拥有的是一个存储库，我希望在名为README.md的项目的根目录中有一个自述文件。有了这个文件，GitHub可以用很好的格式显示它。
由于回购将在机器上的用户主文件夹中签出，所以所有的dotfile都会按预期的方式隐藏，但是README.md不会，这是不需要的。
因此，我不希望在复制回购时，README.md被拉出来。如何做到这一点？
替代解决方案
如果不可能实现上述期望的结果，那么README.md是否可以通过其他方法隐藏或隐藏在主文件夹中？
问题
浏览 4提问于2021-07-12得票数 0
回答已采纳
我使用裸存储库中的git管理我的点文件。有关此方法的详细信息，请参阅。
它工作得很好，但是我想将README.md添加到的根目录中。
如何将README.md添加到github存储库根目录，但而不是将该文件显示在我的主目录中？
如果我将一个README.md推送到github，然后删除主目录中的README.md，这将导致
deleted: README.md
来自git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME status的信息，我更愿意避免。
据我所知，github只在存储库根目录(和子目录)中呈现自述文件和README.md文件，但
浏览 13提问于2020-06-24得票数 10
回答已采纳
3回答
我需要生成一个很长的README.md文件和一些到不同部分的链接，比如开始时的目录。Markdown将部分标题转换为链接：
这是Markdown中的标题和链接
为了生成内容表的链接，我需要锚的值。我所拥有的文本。片断我需要规则。这可能是：
[This is a heading and a link in Markdown](#thisisaheadingandalinkinmarkdown)
有人知道markdown中的标题如何转换为锚点/片段值的规则吗？
浏览 0提问于2017-04-07得票数 3
我正在尝试将docker镜像推送到我在docker hub上的私人存储库。然而，我确实看到在Docker Hub上有一个“信息”部分，我想用关于我的图像的有用信息来更新它。我想知道我是否可以推送一个README.md文件，Docker Hub可以解析这个文件并用它更新“信息”部分。我不确定是否应该将README.md嵌入到我的图像中才能正常工作？
浏览 4提问于2015-03-19得票数 29
回答已采纳
在GitHub上，我用截图创建了一个ReadMe.md
但是当我发布这个网站的时候，它并没有显示图片。我用过
和
<img src="https://raw.github.com/username/projectname/branch/path/to/img.png" alt="https://raw.github.com/username/projectname/branch/path/to/img.png
浏览 2提问于2015-05-22得票数 0
回答已采纳
14回答
有没有一种方法可以从一个Markdown文件中创建一个URL锚点<a>链接到同一个存储库和分支中的另一个文件(也就是相对于当前分支的链接)？
例如，在主分支中，我有一个README.md文件，我希望这样做：
# My Project
is really really cool. My Project has a subdir named myLib, see below.
## myLib documentation
see documentation [here](myLib/README.md)
这将允许我在同一个分支中从一个.md链接到另一个分支，而不必担心我所在的分支(避
浏览 5提问于2011-10-04得票数 1281
回答已采纳
假设我们有以下两个标记文件的GitHub存储库：
README.md
文件/SampleDocumentationPage.md
在README.md中，我们可以通过相对路径或缩短的绝对路径来引用README.md：
See [sample documentation page](Documentation/SampleDocumentationPage.md)
如果我们将包发布到NPM，README.md将显示在包的主页上，其网址如下。
https://www.npmjs.com/package/$SCOPE_NAME$/$PACKAGE_ID$
链接到SampleDocum
浏览 7提问于2022-06-15得票数 5
回答已采纳
1回答
我正在使用它们的API生成一个GitHub注释，方法是在正文中传递一个标记，如下所示
{
"body": "Component \n | --------\n ",
"commit_id": "8574ac234999ffb5bbf93f66fac30a84342fe396",
"path": "
浏览 0提问于2018-12-06得票数 1
我想要做的是将一个PayPal捐赠按钮显示到一个README.md项目的README.md文件中。我添加的标记显示为HTML，而不是正确地呈现为“捐赠”按钮。
HTML // PayPal source here
你有什么想法吗？
浏览 7提问于2015-06-18得票数 11
回答已采纳
1回答
我是npm包scramjet的主要作者--从一个月以来，我在npmjs中README.md的可见性出现了问题。
显示：
"Unable to find a readme for scramjet@4.33.2"
但同时，README.md文件在那里，npm命令不抱怨任何信息。
我检查了这是不是由以下原因引起的：
外部图像
自述的长度
我又试着出版了
和文件也被添加到中。
我试过支持npm，但他们停止了回复，也许这里有人有主意？
编辑：，我是从github获得的一个tarball发布的-所以npm publish <url from gh>
浏览 2提问于2020-07-02得票数 2
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
云直播活动推荐
腾讯云开发者
