有什么区别?"/>
GitHub项目中README和README.md有什么区别?
本文翻译自: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楼
参考:
#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 itemAdd a indent and this will end up as code
For more details: / 有关详细信息,请访问: http : //daringfireball/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:
/ /
Also: 也:
/ /
#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 有了它,您可以轻松地显示标题或使用斜体字,或粗体或几乎任何可以对文本进行的操作
更多推荐
GitHub项目中README和README.md有什么区别?
发布评论