GitHubプロジェクトのREADMEとREADME.mdの違いは何ですか?


387

一部のGitHubプロジェクトにはREADMEファイルだけでなくファイルもあることに気付きましたREADME.md

これらのファイルの違いは何ですか?私READMEはプロジェクトリポジトリページの紹介テキストとしても機能しますが、何をするのかわかりREADME.mdません。


3
:私はこのクイックリファレンス値下げについて(チートシート)に非常に有用であることが分かっhttps://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
アーメドAlnabhan

回答:


381

.mdはmarkdownです。 プロジェクトの下部に表示README.mdされるhtml概要を生成するために使用されます。Githubには独自のMarkdownのフレーバーがあります。

優先順位は:あなたが名前の2つのファイルを持っている場合READMEREADME.md、名前のファイルがREADME.md優先され、githubのの生成に使用されるhtml要約を。


FWIW、Stack Overflow はローカルのMarkdown変更も使用しますStack OverflowのC#Markdown Processorも参照してください)




235

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


非常に簡潔な要約。
Edward Falk 2016


23

README.mdまたは.mkdnまたは.markdown表しファイルがされていることをマークダウンフォーマットされました。Markdownはマークアップ言語です。これを使用すると、ヘッダーを表示したり、イタリックの単語を付けたり、太字やテキストに対して実行できるほとんどすべてのものを使用したりできます

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.