我该如何在Github上查看Markdown文件的源代码?

37

Github在查看markdown(.md)文件时非常有用,会将其呈现为HTML格式(例如,这个 README.md)。

当查看其他任何源文件时,它会显示为未渲染的源代码(例如,这个 .gitignore)。这给出的一个便利功能是通过单击行号直接链接到源中的某一行(例如,像这样)。

我该如何在Github上查看Markdown文件的未渲染源代码(以便我可以链接到源代码中的特定行)?

注意:我知道“Raw”按钮,但它没有提供Github所具有的任何不错的UI界面。

5个回答

15
如果您不想使用“原始”按钮,您可以(自2021年6月起)在GitHub的Markdown文件URL中添加?plain=1

?plain=1附加到任何Markdown文件的URL后,将显示未渲染的文件。

与其他代码文件一样,它也会显示行号,并可用于链接其他用户到特定的行或多行。
例如,附加?plain=1#L52将突出显示纯文本Markdown文件的第52行。

例子:

https://github.com/git/git/blob/master/README.md?plain=1#L49-L51


自2021年9月起, 有一个按钮可以为您添加?plain=1

plain


7
使用“Raw”按钮。例如,如果您正在查看README.md,则导航栏中有一个Raw按钮。这可以是简单的URL更改(从blob到raw),但在这种情况下变成了一个单独的链接。 编辑:Markdown源没有“漂亮”的视图。有转换后的HTML视图、没有UI的原始视图和责任视图。只有责任视图提供了在源代码中链接到特定行的能力。
编辑2:另一种选择是在README.md中使用锚点。以安装标题为例,您可以直接在Markdown文件的内容中进行链接。假设您在Markdown本身中没有隐藏任何内容,那么这将更接近解决您最初的问题。

15
请看我在问题中的留言:注意:我知道“Raw”按钮,但它没有提供Github漂亮的用户界面之一。其中我需要的是通过单击行号直接链接到源代码中的某一行,而“Raw”按钮则无法提供此功能。 - Jess Telford
这是最接近您要求的了。您可以选择原始视图查看代码,或者使用责任缩进来到达该行 - https://github.com/github/hub/blame/master/README.md#L5 - CerealBoy
1
感谢您更新的答案 - 很高兴看到至少有一些解决方法 :) - Jess Telford

5
使用“Blame”按钮,您可以查看Markdown的源代码(例如,像这样)。
不幸的是,“Blame”带有额外的UI元素,使得源代码更加混乱。

您可以使用以下语法链接到一系列行:https://github.com/github/hub/blame/master/README.md#L70-L72。您可以通过单击第一个行号,然后按住 Shift 键单击第二个行号来在 GUI 中选择范围。要将 URL 从具有分支名称(例如 master)转换为具有稳定提交哈希,请按 y 键。 - pt1

1

Refined Github提供了一个额外的“Raw”按钮,用于查看原始源代码并链接到特定行:

enter image description here


0

我在一个扩展名为.wiki的文件上遇到了这个问题,完全让我感到惊讶。看起来,具有.wiki.mediawiki.wikitext扩展名的文件被识别并呈现为HTML格式,甚至带有目录。我猜这是有道理的,毕竟GitHub项目有维基百科。

这很棒,但在这种特定情况下,我真的希望原始的维基文本可见并可复制,而不是一些呈现出来的表示。

我找到的唯一半途而废的解决方案是使用一个虚假的文件扩展名,它不是GitHub认可的扩展名之一,然后使用.gitattributes告诉GitHub如何对其进行语法高亮,例如:

*.wiki_ linguist-language=mediawiki

我对此并不感到兴奋,但根据上面链接的languages.yml,所有好的扩展名都已经被“占用”了。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接