Jaka jest różnica między README i README.md w projektach GitHub?


387

Zauważyłem, że niektóre projekty GitHub zawierają nie tylko READMEplik, ale także README.mdplik.

Jaka jest różnica między tymi plikami? Wiem, że READMEsłuży również jako tekst wprowadzający na stronie repozytorium projektu, ale nie mam pojęcia, co to README.mdrobi.


3
Uważam, że to szybkie odniesienie (ściągawka) dla markdown jest bardzo przydatne: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Ahmed Alnabhan

Odpowiedzi:


381

.md jest markdown. README.mdsłuży do generowania htmlpodsumowania widocznego na dole projektów. Github ma swój własny smak Markdown .

Kolejność preferencji: Jeśli masz dwa pliki o nazwie READMEi README.md, plik o nazwie README.mdjest preferowany i będzie używany do generowania htmlpodsumowania github .


FWIW, Stack Overflow wykorzystuje również lokalne modyfikacje Markdown (zobacz także procesor C # Markdown w przypadku przepełnienia stosu )



1
Doskonała lista funkcji Markdown
Sebastian Norr

235

.md oznacza obniżkę i jest generowany na dole strony github jako html.

Typowa składnia obejmuje:

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

Aby uzyskać więcej informacji: http://daringfireball.net/projects/markdown/


Bardzo zwięzłe streszczenie.
Edward Falk,


23

README.mdlub .mkdnlub .markdownoznacza, że ​​plik ma format przeceniony . Markdown to język znaczników. Dzięki niemu możesz łatwo wyświetlać nagłówki, pisać kursywą, pogrubić tekst lub prawie wszystko, co można zrobić

Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.