Markdown ist eine leichte und einfach zu bedienende Syntax für alle Formen des Schreibens auf der GitHub-Plattform Styling.
Was Sie lernen werden:
- Wie das Markdown-Format die gestylte kollaborative Bearbeitung erleichtert
- Wie unterscheidet sich Markdown von herkömmlichen Formatierungsansätzen
- Wie verwendet man Markdown, um Text zu formatieren
- Wie nutzt man GitHubs automatisches Markdown-Rendering
- Wie wendet man GitHubs einzigartige Markdown-Erweiterungen an
Was ist Markdown?
Markdown ist eine Möglichkeit, Text im Web zu formatieren., Sie steuern die Anzeige des Dokuments; Das Formatieren von Wörtern als fett oder kursiv, das Hinzufügen von Bildern und das Erstellen von Listen sind nur einige der Dinge, die wir mit Markdown tun können. Meistens ist Markdown nur regulärer Text mit ein paar nicht alphabetischen Zeichen, wie #
oder *
.,
Sie können Markdown an den meisten Stellen rund um GitHub verwenden:
- Gists
- Kommentare in Issues und Pull Requests
- Dateien mit der
.md
oder.markdown
Erweiterung
Weitere Informationen finden Sie unter „Schreiben auf GitHub“ in der GitHub-Hilfe.
Beispiele
- Text
- Listen
- Bilder
- Header & Anführungszeichen
- Code
- Extras
Syntaxanleitung
Hier ist eine Übersicht über die Markdown-Syntax, die Sie überall auf GitHub.com oder in Ihren eigenen Textdateien.,3>Headers
# This is an <h1> tag## This is an <h2> tag###### This is an <h6> tag
Emphasis
*This text will be italic*_This will also be italic_**This text will be bold**__This will also be bold___You **can** combine them_
Lists
Unordered
* Item 1* Item 2 * Item 2a * Item 2b
Ordered
1. Item 11. Item 21. Item 3 1. Item 3a 1. Item 3b
Images
!(/images/logo.png)Format: !(url)
Links
http://github.com - automatic!(http://github.com)
Blockquotes
As Kanye West said:> We're living the future so> the present is our past.
Inline code
I think you should use an`<addr>` element here instead.
GitHub Flavored Markdown
GitHub.,com verwendet eine eigene Version der Markdown-Syntax, die eine zusätzliche Reihe nützlicher Funktionen bietet, von denen viele die Arbeit mit Inhalten erleichtern GitHub.com.
Beachten Sie, dass einige Funktionen von GitHub Flavored Markdown nur in den Beschreibungen und Kommentaren von Problemen und Pull-Anforderungen verfügbar sind. Dazu gehören @mentions sowie Verweise auf SHA-1-Hashes, Probleme und Pull-Anforderungen. Aufgabenlisten sind auch in Gist-Kommentaren und in Gist-Markdown-Dateien verfügbar.,
Syntaxhervorhebung
Hier ist ein Beispiel, wie Sie Syntaxhervorhebung mit GitHub Flavored Markdown verwenden können:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
Sie können Ihren Code auch einfach um vier Leerzeichen einrücken:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
Hier hier ist ein Beispiel für Python-Code ohne Syntaxhervorhebung:
def foo(): if not bar: return True
Aufgabenlisten
Wenn Sie eine Aufgabenliste in den ersten Kommentar eines Problems aufnehmen, erhalten Sie eine praktische Fortschrittsanzeige in Ihrer Problemliste. Es funktioniert auch in Pull-Anfragen!,parieren jeder Spalte mit einer Pipe |
:
Würde werden:
Erster Header | Zweiter Header |
---|---|
Inhalt aus Zelle 1 | Inhalt aus Zelle 2 |
Inhalt in der ersten Spalte | Inhalt in der zweiten Spalte |
SHA Referenzen
Jeder Verweis auf die SHA-1 eines Commits hash wird automatisch in einen Link zu diesem Commit auf GitHub konvertiert.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
Frage Verweise innerhalb eines repository
Jede Zahl, bezieht sich auf ein Problem oder eine Pull-Anfrage wird automatisch umgewandelt in einen link.
#1mojombo#1mojombo/github-flavored-markdown#1
Username @mentions
Die Eingabe eines @
– Symbols, gefolgt von einem Benutzernamen, benachrichtigt diese Person, um den Kommentar anzuzeigen. Dies wird als „@mention“ bezeichnet, da Sie die Person erwähnen. Sie können auch Teams innerhalb einer Organisation @mention.,
Automatische Verknüpfung für URLs
Jede URL (wie ) wird automatisch in einen anklickbaren Link konvertiert.
Durchgestrichen
Jedes mit zwei Tilden umwickelte Wort (wie ~~this~~
) erscheint durchgestrichen.
Emoji
GitHub unterstützt emoji!
Um eine Liste aller unterstützten Bilder anzuzeigen, lesen Sie den Emoji-Spickzettel.
Zuletzt aktualisiert am 15.01.2014