我注意到一些GitHub项目不仅有 README 文件,还有 README.md 文件 .
README
README.md
这些文件有什么区别?我知道 README 也作为项目存储库页面的介绍性文本,但我不知道 README.md 的作用 .
.md是markdown . README.md 用于生成您在项目底部看到的 html 摘要 . Github有their own flavor of Markdown .
html
顺序排列:如果您有两个名为 README 和 README.md 的文件,则首选名为 README.md 的文件,它将用于生成github的 html 摘要 .
FWIW,Stack Overflow uses local Markdown modifications as well(另见Stack Overflow's C# Markdown Processor)
.md 扩展名代表Markdown,Github使用它来格式化这些文件 .
.md
了解Markdown:
http://daringfireball.net/projects/markdown/
http://en.wikipedia.org/wiki/Markdown
也:
http://github.github.com/github-flavored-markdown/
README.md 或 .mkdn 或 .markdown 表示文件是markdown格式化的 . Markdown是一种标记语言 . 有了它,您可以轻松地显示 Headers 或使用斜体字,或粗体或几乎任何可以对文本执行的操作
.mkdn
.markdown
.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/
4 回答
.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)
.md
扩展名代表Markdown,Github使用它来格式化这些文件 .了解Markdown:
http://daringfireball.net/projects/markdown/
http://en.wikipedia.org/wiki/Markdown
也:
http://github.github.com/github-flavored-markdown/
README.md
或.mkdn
或.markdown
表示文件是markdown格式化的 . Markdown是一种标记语言 . 有了它,您可以轻松地显示 Headers 或使用斜体字,或粗体或几乎任何可以对文本执行的操作.md
代表markdown,并在github页面的底部生成为html .Typical syntax includes:
For more details: http://daringfireball.net/projects/markdown/