我注意到一些GitHub项目不仅包含README
文件,还包含README.md
文件。
这些文件有什么区别?我知道README
也可以作为项目存储库页面中的介绍性文本,但我不知道README.md
做了什么。
答案 0 :(得分:364)
.md是markdown
。 README.md
用于生成您在项目底部看到的html
摘要。 Github有their own flavor of Markdown。
偏好顺序:如果您有两个名为README
和README.md
的文件,则首选名为README.md
的文件,它将用于生成github的html
摘要。
FWIW,Stack Overflow uses local Markdown modifications as well(另见Stack Overflow's C# Markdown Processor)
答案 1 :(得分:223)
.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
答案 2 :(得分:34)
.md
扩展名代表Markdown,Github使用该扩展来格式化这些文件。
了解Markdown:
http://daringfireball.net/projects/markdown/
http://en.wikipedia.org/wiki/Markdown
此外:
答案 3 :(得分:20)
README.md
或.mkdn
或.markdown
表示文件格式为 markdown 。
Markdown是一种标记语言。有了它,您可以轻松地显示标题或使用斜体字,或粗体或几乎任何可以对文本进行的操作