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

发布于 2024-12-23 07:03:16 字数 122 浏览 4 评论 0原文

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

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

I've noticed some GitHub projects have not only a README file, but also a README.md file.

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.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(4

岛徒 2024-12-30 07:03:17

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

.md stands for markdown and is generated at the bottom of your github page as 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/

原来分手还会想你 2024-12-30 07:03:17

.md 扩展名代表 Markdown,Github 使用它来格式化这些文件。

了解 Markdown:

http://daringfireball.net/projects/markdown/

http://en.wikipedia.org/wiki/Markdown

另外:

http://github.github.com/github-flavored-markdown/

.md extension stands for Markdown, which Github uses, among others, to format those files.

Read about Markdown:

http://daringfireball.net/projects/markdown/

http://en.wikipedia.org/wiki/Markdown

Also:

http://github.github.com/github-flavored-markdown/

宁愿没拥抱 2024-12-30 07:03:17

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

README.md or .mkdn or .markdown denotes that the file is markdown formatted.
Markdown is a markup language. With it you can easily display headers or have italic words, or bold or almost anything that can be done to text

愁杀 2024-12-30 07:03:16

.md 是 markdownREADME.md 用于生成您在项目底部看到的 html 摘要。 Github 有他们自己风格的 Markdown

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


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

.md is markdown. README.md is used to generate the html summary you see at the bottom of projects. Github has their own flavor of 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.


FWIW, Stack Overflow uses local Markdown modifications as well (also see Stack Overflow's C# Markdown Processor)

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文