什么是Github上的“ markdown格式”自述文件?


27

我不清楚格式是什么,是否有创建它的系统/命令行要求等。

基本上,只需要了解规格以及是否有生成README文件的技术步骤即可。


4
不,只是您手动编辑的文本文件。至于语法,请参见en.wikipedia.org/wiki/Markdown
Andrea

3
其与该端使用的Wiki编辑格式相同。
2012年

+1 @Andrea:谢谢,尽管我能想到的不仅仅是少数Markdown格式,但是Github上应该使用哪种格式和版本?另外,您评论的内容多为答案,请作为完整答案发表。再次感谢!
失误2012年

+1 @ K3b:相信您正在做某事,您是否在谈论Github对Gollum的使用,例如允许相对链接?如果是这样,请将此作为答案发布,因为我认为这是正确的答案。谢谢!
失误2012年

Answers:


37

Markdown是一种简单的语法,用于提供语义信息并以纯文本形式表示通用格式。大胆火球有一个很棒的标准降价语法指南。然后GitHub使用这种形式的变种,他们称为GitHub Flavored Markdown

要设置您的自述文件,只需创建一个纯文本文件并将其命名为README(或README.md / README.markdown),然后将其提交到存储库的根目录即可。GitHub然后将其作为项目自述文件。


2
我还创建了一个视频,解释如何使用Markdown。您可以在这里找到它:mikemclin.net/markdown-syntax-language
Mike McLin 2013年

9

Wikipedia — Markdown参考了“ GitHub Flavored Markdown-简介”页面archv。

从页面引用:

GitHub使用我们所谓的“ GitHub Flavored Markdown”(GFM)来处理消息,问题和评论。它在某些重要方面与标准Markdown(SM)不同,并增加了一些其他功能。

该页面还描述了与标准Markdown的区别。

还有更多信息,GitHub如何实际呈现Markdown:

如果您对我们如何呈现Markdown文件感兴趣,则可能需要查看Redcarpet(我们与Sundown库的Ruby接口)。

(显然,Sundown是幕后使用的实际Markdown解析器。)

为了增加一层抽象,Sundown是另一个Markdown解析器的分支:-)
来自Sundown的GitHub页面的报价:

Sundown是Markdown解析器,基于NatachaPorté编写的Upskirt库的原始代码。


1

这很奇怪,但是看起来GitHub 在呈现自述文件时没有使用GitHub-Markdown(GFM)

GitHub在整个网站上使用“ GitHub Flavored Markdown”(即GFM)进行发布,评论和拉取请求。

相反,它似乎使用了一个名为redcarpet的版本作为GitHub标记项目的一部分。它们还支持其他几种标记格式,包括MediaWiki。只需使用正确的文件扩展名,GitHub就会渲染该标记。

如果你想看到降价的两种不同口味的差异,阅读GFM的描述其额外的功能


1
redcarpet和Github Flavored Markdown是两个单独的概念,但是是互补的概念,而不是同一事物的竞争实现。redcarpet基本上是一种编译器,接受使用Github风味Markdown 语言编写的内容并输出HTML或XHTML。
8bittree '16
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.