В чем разница между README и README.md в проектах GitHub?

Я заметил, что некоторые проекты GitHub имеют не только файл README, но и файл README.md.

В чем разница между этими файлами? Я знаю, что README служит также в качестве вводного текста на странице репозитория проекта, но я понятия не имею, что делает README.md.

Ответы

Ответ 1

.md - это markdown. README.md используется для генерации сводки html, которую вы видите внизу проектов. У Github есть собственный вкус Markdown.

Порядок предпочтений: если у вас есть два файла с именами README и README.md, файл с именем README.md предпочтителен, и он будет использоваться для создания сводки github html.

FWIW, Qaru также использует локальные модификации Markdown (см. также Qaru С# Markdown Processor)

Ответ 2

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

Ответ 3

Расширение

.md означает Markdown, которое Github использует, в частности, для форматирования этих файлов.

Подробнее о Markdown:

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

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

также:

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

Ответ 4

README.md или .mkdn или .markdown означает, что файл имеет формат отформатирован. Markdown - это язык разметки. С его помощью вы можете легко отображать заголовки или иметь курсивные слова или полужирный или почти все, что можно сделать с текстом