GitHub项目中的README和README.md有什么区别?
我注意到一些GitHub项目不仅有一个README
文件,而且还有一个README.md
文件。
这些文件有什么区别? 我知道README
也作为项目资源库页面中的介绍性文本,但我不知道什么是README.md
。
.md是markdown
。 README.md
用于生成您在项目底部看到的html
摘要。 Github有自己的降价风格 。
优先顺序:如果您有两个名为README
和README.md
的文件,则首选名为README.md
的文件,它将用于生成github的html
摘要。
FWIW,Stack Overflow也使用本地Markdown修改 (另请参阅Stack Overflow的C#降价处理器 )
.md
代表降价,并在您的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/
.md
扩展名表示Markdown,Github使用其中的格式来格式化这些文件。
阅读关于Markdown:
http://daringfireball.net/projects/markdown/
http://en.wikipedia.org/wiki/Markdown
也:
README.md
或.mkdn
或.markdown
表示该文件是.markdown
格式的。 Markdown是一种标记语言。 有了它,你可以很容易地显示标题或斜体字,或粗体或几乎任何可以做文本的东西