Answers:
Markdown是一种简单的语法,用于提供语义信息并以纯文本形式表示通用格式。大胆火球有一个很棒的标准降价语法指南。然后GitHub使用这种形式的变种,他们称为GitHub Flavored Markdown。
要设置您的自述文件,只需创建一个纯文本文件并将其命名为README(或README.md / README.markdown),然后将其提交到存储库的根目录即可。GitHub然后将其作为项目自述文件。
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库的原始代码。
这很奇怪,但是看起来GitHub 在呈现自述文件时没有使用GitHub-Markdown(GFM)。
GitHub在整个网站上使用“ GitHub Flavored Markdown”(即GFM)进行发布,评论和拉取请求。
相反,它似乎使用了一个名为redcarpet的版本作为GitHub标记项目的一部分。它们还支持其他几种标记格式,包括MediaWiki。只需使用正确的文件扩展名,GitHub就会渲染该标记。