标签: readme

我的大部分 repos 的 README.md 文件都包含有关如何克隆/构建/运行/测试代码的说明：

$ git clone https://github.com/TravelingTechGuy/app-store-validator.git
$ cd app-store-validator
$ npm i
$ npm run build    #lint and build
$ npm run test     #run unit tests

问题是链接是特定于存储库的，即如果存储库已分叉/转移，自述文件仍将包含指向我原始存储库的链接。我遇到了至少一个案例，有人分叉了一个 repo，然后复制/粘贴了安装说明，但不明白为什么不存在更改。

我的问题：有没有办法在 README 文件中添加指向当前repo的链接？这样当克隆时，会指向克隆的回购吗？

我们一直在为项目使用git存储库.我们也从那里下载了一些代码(Say示例代码).

我在每个存储库上找到了ReadMe.md文件.

为什么会这样？什么是.md的含义？

此外,每个文件夹都包含该文件.为什么人们在git存储库中添加该文件？

我不知道,我想知道它,因为我开始使用git进行代码源管理.

README.md在发布时都使用作为描述.通常的做法是使用单个共享文件.

但是,如果我需要使用不同的自述文件并仍然从单个本地仓库发布它而无需手动编辑/替换,该怎么办？

PS

我尝试"readme": "npm-readme.md"在package.json中使用,但它显示了该字段的值,而不是文件的内容

我想在github的README.md中显示一个gif.当目标gif很小时它可以正常工作:

<img src="targetGifUrl" width="400">

但是当gif很大时,它没有按预期显示,以此gif为例.当我将它添加到README.md时,它只显示:

点击后,它会显示一个带提示的网站

超出内容长度

由于gif来自第三个网站,我无法改变它的大小.

那么,是否可以在不保存和调整大小的情况下显示这个大gif ？

我正在尝试使用 GitHub README.md 统计信息显示使用过的语言：

![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=myusername&theme=tokyonight)

但私有和公共存储库大多是C#，未显示：

在Visual Studio 2013 Pro中,有没有办法为根解决方案提供README.md？我们有一个相当大的解决方案,我正在尝试创建一个主要的README.md,它可以给出每个项目的介绍和一个指向README的链接.

有没有办法在github repo的README中添加一个gliffy图？我知道如何添加图像,我已经用gliffy图尝试了这种方法,但它不起作用; gliffy没有渲染.也许正确的问题是,github READMEs是否有一个闪亮的渲染器？

编辑:

我真正想要的是将gliffy xml存储在repo中,它会在引用时自动在README中呈现,而不是将xml 和预渲染图像存储在repo中.

有没有办法在Github readme.md中添加音频栏？我希望能够通过readme.md直接播放某个mp3文件,而不是直接播放到某些soundcloud或youtube链接.提前致谢.

在 PULL_REQUEST_TEMPLATE.md 中按照指示使用相对链接（https://help.github.com/articles/about-readmes/#relative-links-and-image-paths-in-readme-files）不会相对正确地链接.

在实际 PR 中查看时：

• ? [CONTRIBUTING.md](/.github/CONTRIBUTING.md)?

路线：https://github.com/.github/CONTRIBUTING.md。

• [CONTRIBUTING.md](.github/CONTRIBUTING.md)
• ?[CONTRIBUTING.md](./.github/CONTRIBUTING.md)

路线： https://github.com/owner/repo/compare/.github/CONTRIBUTING.md

而不是https://github.com/owner/repo/.github/CONTRIBUTING.md.

更改为../上一级对 PR 有效，但在 GitHub UI 中查看时会断开链接。

单击在 GitHub 上查看的链接有效：https://github.com/fs-webdev/fs-dialog/blob/master/.github/PULL_REQUEST_TEMPLATE.md，只是不在 PR 内。

（我觉得这曾经在 2017 年有效）

在两种情况下按预期具有相对链接功能的正确方法是什么？

问题

我正在尝试在 GitHub 的 README.md 中显示多个图像，x它们之间的边距为px。但出于某种原因，GitHub 似乎剥离了这种margin-right: 30px风格。

降价

[<img style="margin-right: 30px" src=foo.svg height=30>](https://www.example.com/)
[<img style="margin-right: 30px" src=bar.svg height=30>](https://www.example.com/)
<!-- ...and so on -->

注意：我align="left" 在这里尝试过，它工作正常，但在lg sm xs设备上会中断。