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

Question

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

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

Answer 1

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

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

---

FWIW, переполнение стека также использует локальные модификации Markdown (также см. C # переполнения стека)Процессор уценки )

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

Answer 3

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

Прочтите о Markdown:

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

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

Также:

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

Answer 4

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