GitHub项目中README和README.md有什么区别？

最新推荐文章于 2023-09-30 16:28:14 发布

w36680130

最新推荐文章于 2023-09-30 16:28:14 发布

阅读量1.5k

点赞数

文章标签： github markdown

原文链接：https://oldbug.net/q/aJnt/What-is-the-difference-between-README-and-README-md-in-GitHub-projects

版权

本文翻译自：What is the difference between README and README.md in GitHub projects?

I've noticed some GitHub projects have not only a README file, but also a README.md file. 我注意到一些GitHub项目不仅有README文件，还有README.md文件。

What is the difference between these files? 这些文件有什么区别？ I know README serves also as introductory text in the project repository page but I have no idea what README.md does. 我知道README也是项目存储库页面中的介绍性文本，但我不知道README.md作用。

#1楼

参考：https://stackoom.com/question/aJnt/GitHub项目中README和README-md有什么区别

#2楼

.md stands for markdown and is generated at the bottom of your github page as html. .md代表markdown，并在github页面的底部生成为html。

Typical syntax includes: 典型语法包括：

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

For more details: http://daringfireball.net/projects/markdown/ 有关详细信息，请访问： http ： //daringfireball.net/projects/markdown/

#3楼

.md is markdown . .md是markdown 。 README.md is used to generate the html summary you see at the bottom of projects. README.md用于生成您在项目底部看到的html摘要。 Github has their own flavor of Markdown . Github有自己的Markdown风格。

Order of Preference: If you have two files named README and README.md , the file named README.md is preferred, and it will be used to generate github's html summary. 顺序 README.md ：如果您有两个名为README和README.md的文件，则首选名为README.md的文件，它将用于生成github的html摘要。

FWIW, Stack Overflow uses local Markdown modifications as well (also see Stack Overflow's C# Markdown Processor ) FWIW，Stack Overflow也使用本地Markdown修改（另见Stack Overflow的C＃Markdown处理器）

#4楼

.md extension stands for Markdown, which Github uses, among others, to format those files. .md扩展名代表Markdown，Github使用它来格式化这些文件。

Read about Markdown: 了解Markdown：

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

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

Also: 也：

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

#5楼

README.md or .mkdn or .markdown denotes that the file is markdown formatted. README.md或.mkdn或.markdown表示文件是markdown格式化的。 Markdown is a markup language. Markdown是一种标记语言。 With it you can easily display headers or have italic words, or bold or almost anything that can be done to text 有了它，您可以轻松地显示标题或使用斜体字，或粗体或几乎任何可以对文本进行的操作