GitHub 项目中的 README 和 README.md 有啥区别？

Posted 2023-02-18

【中文标题】GitHub 项目中的 README 和 README.md 有啥区别？

【英文标题】：What is the difference between README and README.md in GitHub projects?GitHub 项目中的 README 和 README.md 有什么区别？

【发布时间】：2012-01-29 04:01:27

【问题描述】：

我注意到一些 GitHub 项目不仅有一个 README 文件，而且还有一个 README.md 文件。

这些文件有什么区别？我知道README 也用作项目存储库页面中的介绍性文本，但我不知道README.md 的作用。

【问题讨论】：

我发现这个用于降价的快速参考（备忘单）非常有用：https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

【参考方案1】：

.md 是markdown。 README.md 用于生成您在项目底部看到的html 摘要。 Github 有their own flavor of Markdown。

优先顺序： 如果您有两个文件名为README 和README.md，则首选名为README.md 的文件，它将用于生成github 的html 摘要。

---

FWIW，堆栈溢出 uses local Markdown modifications as well（另见 Stack Overflow's C# Markdown Processor）

【讨论】：

更新了 github markdown help.github.com/articles/github-flavored-markdown

markdown 功能优秀列表：github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

【参考方案2】：

.md 扩展名代表 Markdown，Github 使用它来格式化这些文件。

阅读 Markdown：

http://daringfireball.net/projects/markdown/

http://en.wikipedia.org/wiki/Markdown

还有：

http://github.github.com/github-flavored-markdown/

【参考方案3】：

README.md 或 .mkdn 或 .markdown 表示文件是 markdown 格式的。 Markdown 是一种标记语言。有了它，您可以轻松地显示标题或斜体字，或粗体或几乎任何可以对文本进行的操作

【参考方案4】：

.md 代表 Markdown，在你的 github 页面底部生成为 html。

典型语法包括：

Will become a heading
==============

Will become a sub heading
--------------

*This will be Italic*

**This will be Bold**

- This will be a list item
- This will be a list item

    Add a indent and this will end up as code

更多详情： http://daringfireball.net/projects/markdown/