Was ist der Unterschied zwischen README und README.md in GitHub-Projekten?


387

Ich habe festgestellt, dass einige GitHub-Projekte nicht nur eine READMEDatei, sondern auch eine README.mdDatei enthalten.

Was ist der Unterschied zwischen diesen Dateien? Ich weiß, dass es READMEauch als Einführungstext auf der Projekt-Repository-Seite dient, aber ich habe keine Ahnung, was das README.mdbedeutet.


3
Ich fand diese Kurzreferenz (Cheatsheet) für Markdown sehr nützlich: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Ahmed Alnabhan

Antworten:


381

.md ist markdown. README.mdwird verwendet, um die htmlZusammenfassung zu generieren, die Sie unten in Projekten sehen. Github hat seinen eigenen Geschmack von Markdown .

Präferenzreihenfolge: Wenn Sie zwei Dateien mit dem Namen READMEund haben README.md, wird die genannte Datei README.mdbevorzugt und zum Generieren der htmlZusammenfassung von github verwendet .


FWIW, Stack Overflow verwendet auch lokale Markdown-Modifikationen (siehe auch C # Markdown-Prozessor von Stack Overflow ).



1
Hervorragende Liste der Markdown-Funktionen: github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Sebastian Norr

235

.md steht für Markdown und wird am Ende Ihrer Github-Seite als HTML generiert.

Typische Syntax umfasst:

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

Für weitere Informationen: http://daringfireball.net/projects/markdown/


Sehr kurze Zusammenfassung.
Edward Falk


23

README.mdoder .mkdnoder .markdownbedeutet, dass die Datei mit einem Markdown- Format versehen ist. Markdown ist eine Markup-Sprache. Mit ihm können Sie leicht Überschriften oder kursive Wörter oder Fettdruck oder fast alles, was mit Text getan werden kann, anzeigen

Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.