Яка різниця між README та README.md у проектах GitHub?


387

Я помітив, що деякі проекти GitHub мають не лише READMEфайл, а й README.mdфайл.

Яка різниця між цими файлами? Я знаю, що він READMEтакож є вступним текстом на сторінці сховища проектів, але я поняття не маю README.md.


3
Я вважаю цю швидку довідку (шпаргалку) для розмітки дуже корисною: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Ахмед Алнабхан

Відповіді:


381

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

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


FWIW, Stack Overflow також використовує локальні модифікації Markdown (також див . C # Markdown Processor Stack Overflow )



1
Відмінний список особливостей розмітки
Себастьян Норр

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.