Überschriften
Um eine Überschrift zu erstellen, füge bis zu sechs Rautenzeichen (#) vor dem Text der Überschrift hinzu. Die Anzahl an # bestimmt die Größe der Überschrift.
# Die größte Überschrift
## Die zweitgrößte Überschrift
###### Die kleinste Überschrift
Textstil
Um Text hervorzuheben, kannst Du die Fett- und/oder Kursivschrift verwenden oder den Text durchstreichen.
| Stil | Syntax | Tastenkürzel | Beispiel | Ausgabe |
|---|---|---|---|---|
| Fett | ** ** oder __ __ | Befehlstaste/Strg + B | **Dieser Text ist fett.** | Dieser Text ist fett. |
| Kursiv | * * oder _ _ | Befehlstaste/Strg + I | *Dieser Text ist kursiv.* | Dieser Text ist kursiv. |
| Durchgestrichen | ~~ ~~ | ~~Dieser Text war falsch.~~ | ||
| Fett und kursiv verschachtelt | ** ** und _ _ | **Dieser Text ist _sehr_ wichtig.** | Dieser Text ist sehr wichtig. | |
| Alles fett und kursiv | *** *** | ***Dieser gesamte Text ist wichtig.*** | Dieser gesamte Text ist wichtig. |
Text zitieren
Du kannst einen Text mit einem > zitieren.
Mit den Worten von Abraham Lincoln:
> Verzeihen Sie meine Ausdrucksweise.
Tipp: Beim Anzeigen einer Unterhaltung kannst Du Text in einem Kommentar automatisch zitieren, indem Du den Text markierst und dann r eingibst. Du kannst einen vollständigen Kommentar zitieren, indem Du auf und dann auf Quote reply (Antwort mit Zitat) klickst. Weitere Informationen zu Tastenkürzeln findest Du unter „Tastenkürzel.“
Code zitieren
Du kannst Code oder einen Befehl innerhalb eines Satzes mit einfachen Backticks zitieren. Der Text innerhalb der Backticks wird nicht formatiert.
Verwende `git status`, um alle neuen oder geänderten Dateien aufzulisten, die noch nicht freigegeben wurden.
Um Code oder einen Text in einem eigenen Absatz zu formatieren, verwende dreifache Backticks.
Zu den grundlegenden Git-Befehlen gehören: ``` git status git add git commit ```
Weitere Informationen findest Du unter „Erstellen und Hervorheben von Codeblöcken.“
Links
Du kannst einen Inline-Link erstellen, indem Du den Text in eckige Klammern [ ] einschließt und dann die URL in runde Klammern ( ) einschließt. Einen Link kannst Du auch mit dem Tastenkürzel Befehlstaste/Strg + K erstellen.
Diese Website wurde mit [GitHub Pages](https://pages.github.com/) erstellt.
Tipp: GitHub Enterprise Server erstellt automatisch Links, wenn Du gültige URLs in einen Kommentar einfügst. Weitere Informationen findest Du unter „Automatisch verknüpfte Verweise und URLs.“
Links zu Abschnitten
Du kannst direkt zu einem Abschnitt in einer gerenderten Datei verweisen, indem Du den Mauszeiger über den Abschnittstitel bewegst, um den Link sichtbar zu machen:
Relative Links
Du kannst relative Links und Bildpfade in Deinen gerenderten Dateien definieren, um Leser dabei zu unterstützen, in Deinem Repository zu anderen Dateien zu navigieren.
Ein relativer Link ist ein Verknüpfung, die relativ zur aktuellen Datei ist. Wenn Du beispielsweise eine README-Datei im Stammverzeichnis (root) Deines Repositorys und eine andere Datei in docs/CONTRIBUTING.md hast, könnte der relative Link zu CONTRIBUTING.md in Deiner README-Datei wie folgt aussehen:
[Beitragsrichtlinien für dieses Projekt](docs/CONTRIBUTING.md)
GitHub Enterprise Server wandelt Ihren relativen Link oder den Bildpfad automatisch anhand dessen um, auf welchem Branch Sie sich gerade befinden, damit der Link oder der Pfad immer funktioniert. Du kannst alle relativen Link-Operanden verwenden, beispielsweise ./ und ../.
Relative Links sind für Benutzer, die Dein Repository klonen, einfacher zu verwenden. Absolute Links funktionieren möglicherweise nicht in Klons Deines Repositorys - wir empfehlen relative Links zu verwenden, um auf andere Dateien in Deinem Repository zu verweisen.
Listen
Du kannst eine ungeordnete Liste erstellen, indem Du einer Textzeile oder mehreren Textzeilen ein - oder * voranstellst.
- George Washington
- John Adams
- Thomas Jefferson
Um Deine Liste zu ordnen, stelle jeder Zeile eine Zahl voran.
1. James Madison
2. James Monroe
3. John Quincy Adams
Verschachtelte Listen
Du kannst eine verschachtelte Liste erstellen, indem Du ein Listenelement oder mehrere Listenelemente unter einem anderen Element einrückst.
Beim Web-Editor auf GitHub Enterprise Server oder bei einem Texteditor wie Atom, der eine nicht proportionale Schriftart verwendet, kannst Du Deine Liste visuell ausrichten. Gib vor dem einzurückenden Listenelement so viele Leerzeichen ein, bis das Listenzeichen (- oder *) direkt unter dem ersten Zeichen des darüber liegenden Elements liegt.
1. First list item
- First nested list item
- Second nested list item
Um eine verschachtelte Liste im Kommentareditor auf GitHub Enterprise Server zu erstellen, der keine nicht proportionale Schriftart verwendet, kannst Du Dir das Listenelement direkt über der verschachtelten Liste ansehen und die Anzahl der Zeichen zählen, die vor dem Inhalt dieses Elements stehen. Gib diese Anzahl an Leerzeichen dann vor dem untergeordneten Listenelement ein.
Im folgenden Beispiel kannst Du ein untergeordnetes Listenelement unter dem Listenelement 100. <code>Erstes Listenelement hinzufügen, indem Du das untergeordnete Listenelement um mindestens fünf Leerzeichen einrückst, da sich vor Erstes Listenelement fünf Zeichen (100.) befinden.
100. Erstes Listenelement
- Erstes untergeordnetes Listenelement
Du kannst mit derselben Methode mehrere Ebenen an verschachtelten Listen erstellen. Beispiel: Beim ersten untergeordneten Listenelement stehen sieben Zeichen (␣␣␣␣␣-␣) vor Erstes untergeordnetes Listenelement. Daher musst Du das zweite untergeordnete Listenelement um sieben Leerzeichen einrücken.
100. Erstes Listenelement
- Erstes untergeordnetes Listenelement
- Zweites untergeordnetes Listenelement
Weitere Beispiele findest Du in den GitHub Flavored Markdown-Spezifikationen.
Aufgabenlisten
Um eine Aufgabenliste zu erstellen, füge ein normales Leerzeichen vor die Listenelemente ein, gefolgt von [ ]. Um eine Aufgabe als erledigt zu markieren, verwende [x].
- [x] Beende meine Änderungen
- [ ] Pushe meine Commits nach GitHub
- [ ] Öffne einen Pull Request
Wenn die Beschreibung eines Aufgabenlistenelements mit einer Klammer beginnt, musst Du die Klammer mit einem \ maskieren:
- [ ] \(Optional) Öffne einen Issue zur Nachverfolgung
Weitere Informationen findest Du unter „Informationen zu Aufgabenlisten.“
Personen und Teams erwähnen
Du kannst auf GitHub Enterprise Server eine Person oder ein Team erwähnen, indem Du @ gefolgt vom Benutzer- respektive Teamnamen eingibst. This will trigger a notification and bring their attention to the conversation. Wenn Du einen Kommentar bearbeitest und dabei den Benutzer- oder Teamnamen erwähnst, wird die Person respektive das Team ebenfalls benachrichtigt. For more information about notifications, see "About notifications."
@github/support Wie findet ihr diese Aktualisierungen?
Wenn Du ein übergeordnetes Team erwähnst, erhalten auch die Mitglieder untergeordneter Teams Benachrichtigungen, was die Kommunikation mit mehreren Personengruppen erleichtert. Weitere Informationen finden Sie unter „Informationen zu Teams“.
Wenn Du das Zeichen @ eingibst, wird eine Liste der Personen oder Teams eines Projektes angezeigt. Diese Liste wird während Deiner Eingabe gefiltert. Wenn Du den Namen der gewünschten Person respektive des gewünschten Teams siehst, kannst Du ihn mit den Pfeiltasten auswählen und die Tabulator- oder Eingabetaste drücken, um den Namen zu vervollständigen. Wenn Du Teams erwähnen möchtest, gib den @Organisations-/Teamnamen ein. Alle Mitglieder des Teams werden die Unterhaltung daraufhin abonniert erhalten.
Die automatisch vervollständigten Ergebnisse sind auf Repository-Mitarbeiter und andere Thread-Teilnehmer beschränkt.
Auf Issues und Pull Requests verweisen
Du kannst eine Liste vorgeschlagener Issues und Pull Requests im Repository anzeigen, indem Du # eingibst. Gib die Nummer des Issues oder Pull Requests ein, um die Liste zu filtern, und drücke dann die Tabulator- oder Eingabetaste, um das markierte Ergebnis zu vervollständigen.
Weitere Informationen findest Du unter „Automatisch verknüpfte Verweise und URLs.“
Auf externe Ressourcen verweisen
Wenn benutzerdefinierte Autolink-Referenzen für ein Repository konfiguriert sind, werden Verweise auf externe Ressourcen, beispielsweise ein JIRA-Issue oder ein Zendesk-Ticket, in verkürzte Links umgewandelt. Wenn Du wissen möchtest, welche automatische Verknüpfungen in Deinem Repository verfügbar sind, wende Dich an eine Person mit Administratorberechtigungen für das Repository. Weitere Informationen findest Du unter „Konfigurieren von automatischen Verknüpfungen zum Verweisen auf externe Ressourcen."
Inhaltsanhänge
Einige GitHub Apps stellen Informationen in GitHub Enterprise Server für URLs bereit, die auf die registrierten Domänen verknüpfen. GitHub Enterprise Server zeigt die von der App bereitgestellten Informationen unter der URL im Text oder Kommentar eines Issues bzw. Pull Requests an.
To see content attachments, you must have a GitHub App that uses the Content Attachments API installed on the repository.
Für URLs, die Teil eines Markdown-Links sind, werden keine Inhaltsanhänge angezeigt.
For more information about building a GitHub App that uses content attachments, see "Using Content Attachments."
Emojis verwenden
Du kannst Emojis einfügen, indem Du :EMOJICODE: eingeben.
@octocat :+1: Dieser Pull Request sieht gut aus. Er ist bereit zum Mergen! :shipit:
Bei der Eingabe von : wird eine Liste mit Vorschlägen für Emojis angezeigt. Die Liste wird während der Eingabe gefiltert. Wenn Du den gewünschten Emoji siehst, drücke die Tabulator- oder Eingabetaste, um das markierte Ergebnis zu vervollständigen.
For a full list of available emoji and codes, check out the Emoji-Cheat-Sheet.
Paragraphen
Um einen neuen Absatz zu erstellen, lasse eine Zeile zwischen den Textzeilen leer.
Markdown-Formatierung ignorieren
Sie können GitHub Enterprise Server anweisen, die Markdown-Formatierung zu ignorieren, indem Sie das Markdown-Zeichen mit \ maskieren.
Wir benennen \*unser-neues-Projekt\* in \*unser-altes-Projekt\* um.
Weitere Informationen findest Du unter „Markdown-Syntax“ von Daring Fireball.