Grundlegende Schreib- und Formatierungssyntax

Überschriften

Um eine Überschrift zu erstellen, fügen Sie vor dem Überschriftentext ein bis sechs # Symbole hinzu. Die Anzahl der # verwendeten Elemente bestimmt die Hierarchieebene und die Schriftgröße der Überschrift.

# A first-level heading
## A second-level heading
### A third-level heading

Wenn Sie zwei oder mehr Überschriften verwenden, generiert GitHub automatisch ein Inhaltsverzeichnis, auf das Sie zugreifen können, indem Sie auf das Menüsymbol "Gliederung" innerhalb der Dateiüberschrift klicken. Jeder Überschriftentitel wird im Inhaltsverzeichnis aufgelistet, und Sie können auf einen Titel klicken, um zum ausgewählten Abschnitt zu navigieren.

Formatieren von Text

Sie können die Hervorhebung mit fett, kursiv, durchgestrichenem, tiefgestelltem oder hochgestelltem Text in Kommentarfeldern und .md Dateien angeben.

Stil	Syntax	Tastaturkurzbefehl	Example	Output
Bold

          `** **` oder `__ __`| 
          <kbd>Command</kbd>+<kbd>B</kbd> (Mac) oder <kbd>Ctrl</kbd>+<kbd>B</kbd> (Windows/Linux) | `**This is bold text**` | 
          **Dies ist fett formatierter Text.** |

| Kursiv | * * oder _ _    | Command+I (Mac) oder Ctrl+I (Windows/Linux) | _This text is italicized_ | Dieser Text kursiv formatiert | | Durchgestrichen | ~~ ~~ oder ~ ~ | Nichts | ~~This was mistaken text~~ | Dieser Text war falsch. | | Fett und geschachtelt kursiv formatiert | ** ** und _ _ | Nichts | **This text is _extremely_ important** | Dieser Text ist äußerst wichtig. | | Alles fett und kursiv | *** *** | Nichts | ***All this text is important*** | Dieser Gesamte Text ist wichtig. | | Tiefgestellt | <sub> </sub> | Nichts | This is a <sub>subscript</sub> text | Dies ist ein _{tiefgestellter} Text. | | Hochgestellt | <sup> </sup> | Nichts | This is a <sup>superscript</sup> text | Dies ist ein ^{hochgestellter} Text. | | Unterstreichen | <ins> </ins> | Nichts | This is an <ins>underlined</ins> text | Dies ist ein unterstrichener Text. |

Zitieren von Text

Sie können Text mit einer Anführungszeichen anführungszeichen >.

Text that is not a quote

> Text that is a quote

Zitierter Text wird mit einer vertikalen Linie auf der linken Seite eingezogen und mit grauem Typ angezeigt.

Code zitieren

Sie können Code oder einen Befehl innerhalb eines Satzes mit einzelnen Backticks hervorheben. Der Text innerhalb der Backticks wird nicht formatiert dargestellt. Sie können auch die Command+E (Mac) oder Ctrl drücken.+E (Windows/Linux) Tastenkombination zum Einfügen der Backticks für einen Codeblock in einer Zeile von Markdown.

Use `git status` to list all new or modified files that haven't yet been committed.

Verwenden Sie dreifache Backticks, um Code oder Text in einen eigenen eindeutigen Block zu formatieren.

Some basic Git commands are:
```
git status
git add
git commit
```

Weitere Informationen finden Sie unter Code-Blöcke erstellen und markieren.

Wenn du häufig Codeausschnitte und Tabellen bearbeitest, profitierst du möglicherweise von einer Schriftart mit fester Breite in allen Kommentarfeldern auf GitHub. Weitere Informationen finden Sie unter Informationen zum Schreiben und Formatieren auf GitHub.

Unterstützte Farbmodelle

Bei Problemen, Pullanfragen und Diskussionen können Sie Farben innerhalb eines Satzes mithilfe von Backticks aufrufen. Ein unterstütztes Farbmodell in Backticks zeigt eine Visualisierung der Farbe an.

The background color is `#ffffff` for light mode and `#000000` for dark mode.

Hier sind die derzeit unterstützten Farbmodelle.

Farbe	Syntax	Example	Output
Hexadezimal	`#RRGGBB`	`#0969DA`
RGB	`rgb(R,G,B)`	`rgb(9, 105, 218)`
HSL	`hsl(H,S,L)`	`hsl(212, 92%, 45%)`

Links

Sie können einen Inlinelink erstellen, indem Sie Linktext in eckige Klammern umschließen [ ]und dann die URL in Klammern umschließen ( ). Sie können auch den Tastenkombinationsbefehl+K verwenden, um einen Link zu erstellen. Wenn Sie Text ausgewählt haben, können Sie eine URL aus der Zwischenablage einfügen, um automatisch einen Link aus der Auswahl zu erstellen.

Sie können auch einen Markdown-Link erstellen, indem Sie den Text hervorheben und die Tastenkombination Befehl+V verwenden. Wenn Sie den Text durch den Link ersetzen möchten, verwenden Sie die Tastenkombination Befehl+UMSCHALT+V.

This site was built using [GitHub Pages](https://pages.github.com/).

Abschnittslinks

Sie können direkt eine Verknüpfung mit jedem Abschnitt mit einer Überschrift vornehmen. Um den automatisch generierten Anker in einer gerenderten Datei anzuzeigen, zeigen Sie mit der Maus auf die Abschnittsüberschrift, um das -Symbol verfügbar zu machen, und klicken Sie auf das Symbol, um den Anker in Ihrem Browser anzuzeigen.

Wenn Sie den Anker für eine Überschrift in einer Datei ermitteln müssen, die Sie bearbeiten, können Sie die folgenden Grundlegenden Regeln verwenden:

• Buchstaben werden in Kleinbuchstaben konvertiert.
• Leerzeichen werden durch Bindestriche (-) ersetzt. Alle anderen Leerzeichen oder Satzzeichen werden entfernt.
• Führende und nachfolgende Leerzeichen werden entfernt.
• Markupformatierung wird entfernt, sodass nur der Inhalt (z. B _italics_ . wird italics).
• Wenn der automatisch generierte Anker für eine Überschrift mit einem früheren Anker im selben Dokument identisch ist, wird ein eindeutiger Bezeichner durch Anfügen eines Bindestrichs und einer automatisch erhöhten ganzzahligen Zahl generiert.

Ausführlichere Informationen zu den Anforderungen von URI-Fragmenten finden Sie unter RFC 3986: Uniform Resource Identifier (URI): Generische Syntax, Abschnitt 3.5.

Der folgende Codeblock veranschaulicht die grundlegenden Regeln, die zum Generieren von Ankern aus Überschriften in gerenderten Inhalten verwendet werden.

# Example headings

## Sample Section

## This'll be a _Helpful_ Section About the Greek Letter Θ!
A heading containing characters not allowed in fragments, UTF-8 characters, two consecutive spaces between the first and second words, and formatting.

## This heading is not unique in the file

TEXT 1

## This heading is not unique in the file

TEXT 2

# Links to the example headings above

Link to the sample section: [Link Text](#sample-section).

Link to the helpful section: [Link Text](#thisll-be-a-helpful-section-about-the-greek-letter-Θ).

Link to the first non-unique section: [Link Text](#this-heading-is-not-unique-in-the-file).

Link to the second non-unique section: [Link Text](#this-heading-is-not-unique-in-the-file-1).

Relative Verknüpfungen

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 sich beispielsweise eine README-Datei im Root deines Repositorys und eine andere Datei in docs/CONTRIBUTING.md befindet, sieht der relative Link zu CONTRIBUTING.md in deiner README-Datei wie folgt aus:

[Contribution guidelines for this project](docs/CONTRIBUTING.md)

GitHub wandelt deinen relativen Link oder Bildpfad automatisch anhand dessen um, in welchem Branch du dich gerade befindest, damit der Link oder der Pfad immer funktioniert. Der Pfad des Links ist relativ zur aktuellen Datei. Links, die mit / beginnen, sind relativ zum Repositorystamm. Du kannst alle relativen Linkoperanden verwenden, z. B. ./ und ../.

Ihr Linktext sollte sich in einer einzelnen Zeile befindet. Das folgende Beispiel funktioniert nicht.

[Contribution
guidelines for this project](docs/CONTRIBUTING.md)

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.

Benutzerdefinierte Anker

Sie können standardmäßige HTML-Ankertags (<a name="unique-anchor-name"></a>) verwenden, um Navigationsankerpunkte für eine beliebige Position im Dokument zu erstellen. Um mehrdeutige Verweise zu vermeiden, verwenden Sie ein eindeutiges Benennungsschema für Ankertags, z. B. das Hinzufügen eines Präfixes zum name Attributwert.

Sie können eine Verknüpfung mit einem benutzerdefinierten Anker herstellen, indem Sie den Wert des Attributs verwenden, das name Sie dem Anker gegeben haben. Die Syntax entspricht genau dem, wenn Sie eine Verknüpfung mit einem Anker herstellen, der automatisch für eine Überschrift generiert wird.

Beispiel:

# Section Heading

Some body text of this section.

<a name="my-custom-anchor-point"></a>
Some text I want to provide a direct link to, but which doesn't have its own heading.

(… more content…)

[A link to that custom anchor](#my-custom-anchor-point)

Zeilenumbrüche

Wenn Sie Issues, Pull-Anfragen oder Diskussionen in einem Repository erstellen, wird GitHub automatisch einen Zeilenumbruch rendern.

This example
Will span two lines

Wenn Sie jedoch in einer MD-Datei schreiben, würde das obige Beispiel in einer Zeile ohne Zeilenumbruch gerendert. Um einen Zeilenumbruch in einer MD-Datei zu erstellen, müssen Sie einen der folgenden Elemente einschließen:

• Schließen Sie am Ende der ersten Zeile zwei Leerzeichen ein.

  This example  
  Will span two lines
  

• Schließen Sie einen Backslash am Ende der ersten Zeile ein.

  This example\
  Will span two lines
  

• Fügen Sie am Ende der ersten Zeile ein HTML-Zeilenumbruch-Tag hinzu.

  This example<br/>
  Will span two lines
  

Wenn Sie eine leere Zeile zwischen zwei Zeilen lassen, werden sowohl .md-Dateien als auch Markdown in Issues, Pull-Anfragen und Diskussionen die beiden Zeilen getrennt durch die leere Zeile dargestellt.

This example

Will have a blank line separating both lines

Bilder

Sie können ein Bild anzeigen, indem Sie es hinzufügen! und umschließen des Alternativtexts in [ ]. Alternativtext ist eine kurze Textentsprechung der Informationen im Bild. Umschließen Sie dann den Link für das Bild in Klammern ().

![Screenshot of a comment on a GitHub issue showing an image, added in the Markdown, of an Octocat smiling and raising a tentacle.](https://myoctocat.com/assets/images/base-octocat.svg)

GitHub unterstützt das Einbetten von Bildern in Ihre Probleme, Pullanforderungen, Kommentare und .md Dateien. Sie können ein Bild aus Ihrem Repository anzeigen, einen Link zu einem Onlinebild hinzufügen oder ein Bild hochladen. Weitere Informationen finden Sie unter "Hochladen von Ressourcen".

Hier sind einige Beispiele für die Verwendung relativer Links zum Anzeigen eines Bilds.

Kontext	Relative Verknüpfung
In einer .md Datei in derselben Verzweigung	/assets/images/electrocat.png
In einer Datei in einer .md anderen Verzweigung	/../main/assets/images/electrocat.png
Bei Problemen, Pull-Anfragen und Kommentaren des Repositorys	../blob/main/assets/images/electrocat.png?raw=true
In einer Datei in einem .md anderen Repository	/../../../../github/docs/blob/main/assets/images/electrocat.png
Bei Problemen rufen Sie Anforderungen und Kommentare eines anderen Repositorys ab	../../../github/docs/blob/main/assets/images/electrocat.png?raw=true

Weitere Informationen finden Sie unter "Relative Links".

Das Bild-Element

Das <picture> HTML-Element wird unterstützt.

Lists

Sie können eine ungeordnete Liste erstellen, indem Sie eine oder mehrere Textzeilen mit -, oder *+.

- George Washington
* John Adams
+ Thomas Jefferson

Um Ihre Liste zu sortieren, stellen Sie jeder Zeile eine Nummer voran.

1. James Madison
2. James Monroe
3. John Quincy Adams

Geschachtelte Listen

Sie können eine geschachtelte Liste erstellen, indem Sie ein oder mehrere Listenelemente unter einem anderen Element einrücken.

Zum Erstellen einer geschachtelten Liste mithilfe des Web-Editors auf GitHub oder einem Text-Editor, der eine einfarbige Schriftart verwendet, z. B. Visual Studio Code, können Sie Ihre Liste visuell ausrichten. Geben Sie Leerzeichen vor dem geschachtelten Listenelement ein, bis sich das Listenmarkierungszeichen (- oder *) direkt unterhalb des ersten Zeichens des Texts im darüber liegenden Element befindet.

1. First list item
   - First nested list item
     - Second nested list item

Zum Erstellen einer geschachtelten Liste im Kommentar-Editor auf GitHub, die keine monospaced Schriftart verwendet, können Sie das Listenelement direkt oberhalb der geschachtelten Liste betrachten und die Anzahl der Zeichen zählen, die vor dem Inhalt des Elements angezeigt werden. Geben Sie dann diese Anzahl von Leerzeichen vor dem geschachtelten Listenelement ein.

In diesem Beispiel können Sie ein geschachteltes Listenelement unter dem Listenelement 100. First list item hinzufügen, indem Sie das geschachtelte Listenelement mindestens fünf Leerzeichen einrücken, da es vor 100. fünf Zeichen (First list item) gibt.

100. First list item
     - First nested list item

Sie können mehrere Ebenen geschachtelter Listen mit derselben Methode erstellen. Da beispielsweise das erste geschachtelte Listenelement sieben Zeichen () vor dem geschachtelten Listeninhalt ␣␣␣␣␣-␣enthält, müssen Sie das zweite geschachtelte Listenelement um mindestens zwei weitere Zeichen einrückenFirst nested list item (mindestens neun Leerzeichen).

100. First list item
     - First nested list item
       - Second nested list item

Weitere Beispiele finden Sie unter GitHub Flavored Markdown Spec.

Aufgabenlisten

Um eine Aufgabenliste zu erstellen, stellst du den Listenelementen einen Bindestrich und ein Leerzeichen gefolgt von [ ] voran. Um eine Aufgabe als erledigt zu markieren, verwende [x].

- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:

Wenn eine Beschreibung eines Aufgabenlistenelements mit einer Klammer beginnt, müssen Sie sie mit \:

- [ ] \(Optional) Open a followup issue

Weitere Informationen finden Sie unter Informationen zu Aufgabenlisten.

Erwähnen von Personen und Teams

Sie können eine Person oder ein Team auf GitHub erwähnen, indem Sie den Benutzernamen oder den Teamnamen eingeben @ . Dadurch wird eine Benachrichtigung ausgelöst und ihre Aufmerksamkeit auf die Unterhaltung lenken. Personen erhalten auch eine Benachrichtigung, wenn Sie einen Kommentar bearbeiten, um ihren Benutzernamen oder Teamnamen zu erwähnen. Weitere Informationen zu Benachrichtigungen findest du unter Informationen zu Benachrichtigungen.

@github/support What do you think about these updates?

Wenn Sie ein übergeordnetes Team erwähnen, erhalten Mitglieder seiner untergeordneten Teams ebenfalls Benachrichtigungen, was die Kommunikation mit mehreren Personengruppen vereinfacht. Weitere Informationen finden Sie unter Informationen zu den Organisationsteams.

Wenn Sie ein @ Symbol eingeben, wird eine Liste von Personen oder Teams in einem Projekt angezeigt. Die Liste wird während der Eingabe dynamisch gefiltert. Sobald Sie den Namen der gesuchten Person oder des gesuchten Teams gefunden haben, können Sie die Pfeiltasten verwenden, um diesen auszuwählen und entweder die Tabulator- oder die Eingabetaste drücken, um die Eingabe abzuschließen. Geben Sie für Teams die @organization/team-name Unterhaltung ein, und alle Mitglieder dieses Teams werden abonniert.

Die Ergebnisse der Autovervollständigung sind auf Repository-Mitwirkende und weitere Diskussionsteilnehmer beschränkt.

Verweisen auf Probleme und Pullanforderungen

Sie können eine Liste der vorgeschlagenen Probleme und Pullanforderungen innerhalb des Repositorys durch Eingabe #aufrufen. Geben Sie das Problem oder die Pullanforderungsnummer oder den Titel ein, um die Liste zu filtern, und drücken Sie dann die TAB-TASTE, oder drücken Sie die EINGABETASTE, um das hervorgehobene Ergebnis abzuschließen.

Weitere Informationen finden Sie unter Automatisch verlinkte Verweise und URLs.

Verweisen auf externe Ressourcen

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 finden Sie unter Autolinks konfigurieren, um auf externe Ressourcen zu referenzieren.

Hochladen von Ressourcen

Sie können Objekte wie Bilder hochladen, indem Sie sie ziehen und ablegen, aus einem Dateibrowser auswählen oder einfügen. Sie können Ressourcen in Probleme, Pullanforderungen, Kommentare und .md Dateien in Ihrem Repository hochladen.

Verwenden von Emojis

Sie können Ihrem Schreiben Emojis hinzufügen, indem Sie einen Doppelpunkt gefolgt vom Namen des Emojis eingeben :EMOJICODE:.

@octocat :+1: This PR looks great - it's ready to merge! :shipit:

Eingabe : wird eine Liste mit vorgeschlagenen Emojis angezeigt. Die Liste wird während der Eingabe gefiltert. Sobald Sie das gesuchte Emoji gefunden haben, drücken Sie die TAB-TASTE oder EINGABETASTE , um das hervorgehobene Ergebnis abzuschließen.

Eine vollständige Liste der verfügbaren Emojis und Codes finden Sie im Emoji-Cheat-Sheet.

Paragraphs

Sie können einen neuen Absatz erstellen, indem Sie eine leere Zeile zwischen Textzeilen verlassen.

Fußnoten

Sie können Ihren Inhalten Fußnoten hinzufügen, indem Sie diese Klammernsyntax verwenden:

Here is a simple footnote[^1].

A footnote can also have multiple lines[^2].

[^1]: My reference.
[^2]: To add line breaks within a footnote, add 2 spaces to the end of a line.  
This is a second line.

Die Fußnote wird wie folgt gerendert:

Alarmsignale

Warnungen, auch als Legenden oder Anzeigen bezeichnet, sind eine Markdown-Erweiterung basierend auf der Blockquotesyntax, mit der Sie wichtige Informationen hervorheben können.**** Auf GitHub werden sie mit unverwechselbaren Farben und Symbolen angezeigt, um die Bedeutung des Inhalts anzugeben.

Verwenden Sie Warnungen nur, wenn sie für den Benutzererfolg von entscheidender Bedeutung sind, und beschränken Sie sie auf ein oder zwei pro Artikel, um zu verhindern, dass der Leser überlastet wird. Darüber hinaus sollten Sie vermeiden, Benachrichtigungen aufeinander zu platzieren. Warnungen können nicht in anderen Elementen geschachtelt werden.

Um eine Warnung hinzuzufügen, verwenden Sie eine spezielle Blockquotezeile, die den Warnungstyp angibt, gefolgt von den Warnungsinformationen in einer Standardblockquote. Es stehen fünf Arten von Warnungen zur Verfügung:

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

Hier sind die gerenderten Warnungen:

Ausblenden von Inhalten mit Kommentaren

Sie können GitHub anweisen, Inhalte aus dem gerenderten Markdown auszublenden, indem Sie den Inhalt in einem HTML-Kommentar platzieren.

<!-- This content will not appear in the rendered Markdown -->

Ignorieren der Markdown-Formatierung

Sie können GitHub anweisen, die Markdown-Formatierung mithilfe des \ Markdown-Zeichens zu ignorieren (oder escape).

Let's rename \*our-new-project\* to \*our-old-project\*.

Weitere Informationen zu umgekehrten Schrägstrichen finden Sie unter Daring Fireballs Markdown-Syntax.

Deaktivieren des Markdown-Renderings

Weiterführende Lektüre

•         [GitHub Flavored Markdown – Spezifikation](https://github.github.com/gfm/)
  

•         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)
  

•         [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting)
  

•         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)