В чем разница между README и README.md в проектах GitHub?
Я заметил, что некоторые проекты GitHub имеют не только README
файл, но и README.md
файл.
В чем разница между этими файлами? я знаю README
служит также вводным текстом на странице репозитория проекта, но я понятия не имею, что README.md
делает.
4 ответа
.md это markdown
, README.md
используется для генерации html
Резюме вы видите в нижней части проектов. У Github есть собственный аромат Markdown.
Порядок предпочтений: если у вас есть два файла с именем README
а также README.md
файл с именем README.md
является предпочтительным, и он будет использоваться для создания GitHub html
резюме.
FWIW, в Stack Overflow также используются локальные модификации Markdown (также см. Процессор 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
обозначает, что файл отформатирован в формате уценки. Уценка - это язык разметки. С его помощью вы можете легко отображать заголовки или курсивные слова, жирный шрифт или почти все, что можно сделать с текстом