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


388

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

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


3
Я нашел этот краткий справочник (
чит-лист

Ответы:


382

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

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


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


5
Обновленная уценка
Пол Грегуар,

1
Отличный список функций уценки: github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Себастьян Норр,

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/


Очень краткое резюме.
Эдвард Фальк,

37

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

Читайте о Markdown:

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

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

Также:

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


4
+1 за ссылку на страницу Github: github.github.com/github-flavored-markdown, особенно `` `для блоков кода
AJP

23

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

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.