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


387

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

这些文件有什么区别?我知道README也可以在项目存储库页面中用作介绍性文本,但我不知道该怎么README.md做。


3
我发现此降价快速参考(速查表)非常有用:https
Ahmed Alnabhan

Answers:


381

.md是markdownREADME.md用于生成html您在项目底部看到的摘要。Github有Markdown的特色

优先顺序:如果有两个名为READMEREADME.md的文件,README.md则首选名为的文件,该文件将用于生成github的html摘要。


FWIW,Stack Overflow也使用本地Markdown修改(另请参阅Stack Overflow的C#Markdown处理器



1

235

.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/


摘要非常简洁。
爱德华·福克


23

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

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.