wake-up-neo.com

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

Ich habe bemerkt, dass einige GitHub-Projekte nicht nur eine README -Datei haben, sondern auch eine README.md -Datei.

Was ist der Unterschied zwischen diesen Dateien? Ich weiß, dass README auch als Einführungstext auf der Projektarchivseite dient, aber ich habe keine Ahnung, was README.md tut.

373

.md ist markdown . README.md wird verwendet, um die html-Zusammenfassung zu generieren, die unten in Projekten angezeigt wird. Github hat ihren eigenen Geschmack von Markdown .

Reihenfolge der Einstellungen: Wenn Sie zwei Dateien mit dem Namen README und README.md haben, wird die Datei mit dem Namen README.md bevorzugt wird verwendet, um die html-Zusammenfassung von github zu generieren.


FWIW, Stack Overflow verwendet auch lokale Markdown-Modifikationen (siehe auch Stack Overflow's C # Markdown Processor )

370
Mike Pennington

.md steht für Markdown und wird am unteren Rand 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 Details: http://daringfireball.net/projects/markdown/

226
Foxinni

.md steht für Markdown, mit dem Github unter anderem diese Dateien formatiert.

Lesen Sie mehr über Markdown:

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

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

Ebenfalls:

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

36
Paul

README.md oder .mkdn oder .markdown gibt an, dass die Datei Abschrift formatiert ist. Markdown ist eine Auszeichnungssprache. Mit ihm können Sie leicht Überschriften oder kursive Wörter anzeigen oder fett oder fast alles, was mit Text getan werden kann

21
c00kiemon5ter