私はいくつかのGitHubプロジェクトがREADME
ファイルだけでなくREADME.md
ファイルも持っていることに気づきました。
これらのファイルの違いは何ですか?私はREADME
がプロジェクトリポジトリページの紹介文としても役立つことを知っていますが、README.md
が何をするのか私にはわかりません。
.mdは markdown
です。 README.md
は、プロジェクトの下部に表示されるhtml
の概要を生成するために使用されます。 Githubには 独自のMarkdown風味 があります。
優先順位: README
とREADME.md
という名前の2つのファイルがある場合は、README.md
という名前のファイルが優先され、それがgithubのhtml
要約の生成に使用されます。
FWIW、Stack Overflow ローカルのMarkdownの変更も同様に使用します (また、 Stack OverflowのC#Markdown Processor も参照してください)
.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
.md
拡張子はMarkdownを表し、Githubはこれらのファイルをフォーマットするために特に使用します。
Markdownについて読む:
http://daringfireball.net/projects/markdown/
http://en.wikipedia.org/wiki/Markdown
また:
README.md
または.mkdn
または.markdown
は、ファイルが markdown 形式であることを示します。マークダウンはマークアップ言語です。それを使用すると、簡単にヘッダーを表示したり、イタリックの単語を含めることができます。