标签: readme

如果自述文件由repo自动查看,自述文件中的相对链接将被破坏

我在github上有一个repo作为组织的一部分.例如:

MYORGANIZATION/MyRepository

repo包含README.md文件.

在这个README.md文件中,我有一个链接,所以另一个.md文件位于与README.md相同的文件夹中的同一个repo中:

/README.md /anotherMarkdown.md

README.md包含一个相对链接(如下所述:https://help.github.com/articles/relative-links-in-readmes/ )到anotherMarkdown.md:

[This is my relative link](anotherMarkdown.md)
Run Code Online (Sandbox Code Playgroud)

如果我使用此URL打开自述文件,相关链接将起作用:

https://github.com/MYORGANIZATION/MyRepository/blob/master/README.md

链接指向:

https://github.com/MYORGANIZATION/MyRepository/blob/master/anotherMarkdown.md

如果我打开Repository-URL https://github.com/MYORGANIZATION/MyRepository/,则会显示reposiutory的根目录,以及文件列表下方的自述文件.

但是上面描述的相对链接现在被打破(给出404)并指向:

https://github.com/MYORGANIZATION/MyRepository/anotherMarkdown.md

这是预期的行为吗?我的链接有什么问题?

markdown github readme

10
推荐指数
1
解决办法
267
查看次数

GitHub 支持 README 的哪些文件类型

我注意到 GitHub README 使用了许多不同的文件类型。最常见的是.md.rst

查看 GitHub 文档和帮助页面后,我没有发现有关允许哪些文件类型的信息。

我只是在寻找一个类型列表,这样我就可以弄清楚我可以在下一个自述文件中使用哪些类型。

file-type github readme

10
推荐指数
1
解决办法
2183
查看次数

在GitHub存储库上添加多个自述文件

是否可以在git存储库上添加多个自述文件?编写法语和英语文件,例如(README.fr.mdREADME.en.md)。

(当然,我知道有可能,但是GitHub并未将其识别为自述文件。)

multilingual github readme

9
推荐指数
1
解决办法
2613
查看次数

8
推荐指数
3
解决办法
1486
查看次数

如何更改 github README.md 的渲染宽度?

当浏览到https://github.com/timotheecour/D_vs_nimhttps://github.com/timotheecour/D_vs_nim/blob/master/README.md时,我希望显示的降价以自定义(更大)宽度显示。那可能吗?如果可能的话,宽度将取决于浏览器窗口的大小,例如width=max(browser_width, fixed_width)

编辑:好奇https://github.com/github/markup中的 PR 是否有助于实现这一目标。

markdown github width readme

8
推荐指数
1
解决办法
5353
查看次数

仅使用 HTML 使 GitHub 的 README 在智能手机和台式机上看起来不同(CSS 受限)

我有一个带有README.md文件的 GitHub 项目。我通过以下方式嵌入图像

<img src="./logo.svg" align="right" width="180px">
Run Code Online (Sandbox Code Playgroud)

这是此类图像的示例

注意: GitHub 允许使用嵌入式 HTML 但不允许使用 CSS,这就是我使用width属性而不是 css 的原因。

这样图像就占据了屏幕的右侧,允许将文本放在左侧。

问题:如果您在智能手机上打开此类链接,则文本空间太小,并且拆分的单词或字母占据整行看起来很糟糕。如果我可以使用更大的width专门用于移动设备,那就太好了。但是 GitHub 限制在 markdown 文件中使用 CSS,我不能使用@media查询。

问题:如何在不使用 CSS 的情况下使 GitHub 的 README 在移动和桌面上看起来不同?

html css github readme

8
推荐指数
1
解决办法
371
查看次数

如何创建指向 readme.md 文件指定部分的链接?

我正在练习自述文件,我有一个关于链接的问题。有没有办法链接到自述文件的特定部分?例如,我想创建一个目录,其中包含指向 readme.md 文件的特定部分的链接。

# Title
## Sub Title
Brief description of project.

### Table of Content
* [Section 1](#section1)
* [Section 2](#section2)
* [Section 3](#section3)

# Section 1
some text

# Section 2
some text

# Section 3
some text
Run Code Online (Sandbox Code Playgroud)

根据我的理解,我认为这会起作用,但链接不会将我带到这些部分,当我单击它们时,它不会执行任何操作。

markdown readme

8
推荐指数
1
解决办法
5629
查看次数

GitHub 自述文件错误:请在 vercel 中使用您的 github 令牌添加名为 PAT_1 的环境变量

我在 GitHub 自述文件中使用了这个。

<img align="center" height="170" src="https://github-readme-stats.vercel.app/api/top-langs/?username=[GitHub UserName]&layout=compact&langs_count=16&theme=dracula"/>
Run Code Online (Sandbox Code Playgroud)

但现在它说,“出了点问题!在https://tiny.one/readme-stats上提交问题超过最大重试次数请在 vercel 中添加一个名为 PAT_1 的环境变量以及您的 github 令牌”

github readme

8
推荐指数
1
解决办法
683
查看次数

git repo中的README.md文件有什么作用?

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

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

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

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

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

git github readme

7
推荐指数
1
解决办法
4255
查看次数

来自第三方网站的大gif没有显示在github的README.md中?

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

<img src="targetGifUrl" width="400">
Run Code Online (Sandbox Code Playgroud)

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

在此输入图像描述

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

超出内容长度

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

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

github readme

7
推荐指数
1
解决办法
2236
查看次数

标签 统计

readme ×10

github ×9

markdown ×3

css ×1

file-type ×1

git ×1

html ×1

multilingual ×1

shields.io ×1

width ×1