Vorherige

Nächste

Was ist Markdown?

Abgeschlossen

Markdown ist eine Markupsprache, die einen schlanken Ansatz für die Bearbeitung von Inhalten bietet, indem sie die Ersteller von Inhalten vom Overhead von HTML abschirmt. Obwohl HTML zum Rendern von Inhalten so funktioniert, wie es gedacht war, nimmt HTML-Syntax doch viel Speicherplatz in Anspruch und kann auch bei kleinerer Syntax unübersichtlich werden. Mit der Erfindung von Markdown wurde ein guter Kompromiss zwischen der Leistungsfähigkeit von HTML für die Inhaltsbeschreibung und der Einfachheit von Nur-Text für die Bearbeitung geschaffen.

In dieser Einheit wird die von Markdown verwendete Struktur und Syntax beschrieben. Wir behandeln auch Features von GitHub-Flavored Markdown (GFM), einer Reihe von Syntaxerweiterungen, mit denen Sie GitHub-Features in Inhalte integrieren können.

Hinweis

Diese Lerneinheit soll Ihnen einen Einblick in Markdown geben. Eine ausführlichere Übersicht finden Sie in den Artikeln „Beschreibung der Markdownsyntax“ und „Spezifikation zu GitHub Flavored Markdown“ in der zusammenfassenden Einheit am Ende dieses Moduls.

Hervorheben von Text

Der wichtigste Teil jeglicher Kommunikation auf GitHub ist normalerweise der Text selbst, doch wie markieren Sie, dass einige Teile des Texts wichtiger sind als andere?

Die Verwendung von Kursivformatierung im Text ist so einfach wie das Umschließen des Zieltexts mit einem einzelnen Sternchen (*) oder Unterstrich (_). Achten Sie nur darauf, dass Sie eine Hervorhebung mit demselben Zeichen schließen, mit dem Sie sie begonnen haben. Achten Sie darauf, wie Sie die Verwendung von Sternchen und Unterstrichen kombinieren. Beispiele:

This is *italic* text.
This is also _italic_ text.

This is italic text. (Kursiver Text) Dies ist auch kursiv formatierter Text.

Erstellen Sie fett formatierten Text mit zwei Sternchen (**) oder zwei Unterstrichen (__).

This is **bold** text.
This is also __bold__ text.

This is bold text. (Fett formatierter Text) Dies ist auch fett formatierter Text.

Sie können auch verschiedene Betonungen mischen.

_This is **italic and bold** text_ using a single underscore for italic and double asterisks for bold.
__This is bold and *italic* text__ using double underscores for bold and single asterisks for italic. 

Dies ist kursiv und fett formatierter Text mit einem einfachen Unterstrich für Kursiv- und zwei Sternchen für Fettformatierung. Dies ist fett und kursiv formatierter Text mit doppelten Unterstrichen für Fett- und einem einzelnen Sternchen für Kursivformatierung.

Um ein literales Sternchen zu verwenden, stellen Sie ihm ein Escapezeichen voran. In GFM ist dies ein umgekehrter Schrägstrich (\). Dieses Beispiel führt zu den Unterstrichen und Sternchen, die in der Ausgabe angezeigt werden.

\_This is all \*\*plain\*\* text\_.

_This is all **plain** text_ (Nur-Text).

Deklarieren von Überschriften

HTML stellt Inhaltsüberschriften wie das <h1>-Tag bereit. In Markdown wird dies über das #-Symbol unterstützt. Verwenden Sie einfach eine Raute (#) für jede Überschriftenebene von 1–6.

###### This is H6 text

Die ist H6-Text

Verknüpfen mit Bildern und Websites

Bild- und Websitelinks verwenden eine ähnliche Syntax.

![Link an image.](/learn/azure-devops/shared/media/mara.png)

[Link to Microsoft Training](/training)

Link zu Microsoft Training

Erstellen von Listen

Sie können sortierte und unsortierte Listen definieren. Sie können auch die durch Einzug geschachtelten Elemente (nested items) definieren.

• Geordnete Listen beginnen mit Zahlen.
• Ungeordnete Listen können Sternchen oder Bindestriche (-) verwenden.

Hier sehen Sie das Markdown für eine sortierte Liste:

1. First
1. Second
1. Third

Ergebnis:

1. First
2. Second
3. Third

- First
  - Nested
- Second
- Third

Hier ist der Markdown für eine ungeordnete Liste:

• Ersten
  • Nested
• Second
• Third

Erstellen von Tabellen

Sie können Tabellen mit einer Kombination aus Pipes (|) für Spaltenumbrüche und Bindestrichen (-) zur Kennzeichnung der vorherigen Zeile als Kopfzeile erstellen.

First|Second
-|-
1|2
3|4

First	Second
1	2
3	4

Zitieren von Text

Sie können Blockzitate mithilfe des Größer-als-Zeichens (>) erstellen.

> This is quoted text.

This is quoted text.

Auffüllen von Lücken mit Inline-HTML

Wenn Sie über ein HTML-Szenario verfügen, das von Markdown nicht unterstützt wird, können Sie diesen HTML-Code inline verwenden.

Here is a<br />line break

Here is a
line break

Arbeiten mit Code

Markdown bietet Standardverhalten für die Arbeit mit Inlinecodeblöcken, die durch das Hochkommazeichen (`) getrennt sind. Wenn Text mit diesem Zeichen versehen wird, wird er als Code gerendert.

This is `code`.

This is code.

Wenn ein Codesegment mehrere Zeilen umfasst, können Sie drei Hochkommazeichen (```) vor und nach dem Codesegment verwenden, um einen abgeschlossenen Codeblock zu erstellen.

```markdown
var first = 1;
var second = 2;
var sum = first + second;
```

var first = 1;
var second = 2;
var sum = first + second;

GitHub Flavored Markdown erweitert diese Unterstützung mit Syntaxhervorhebung für beliebte Sprachen. Geben Sie einfach die Sprache als Teil der ersten Hochkommasequenz an.

```javascript
var first = 1;
var second = 2;
var sum = first + second;
```

var first = 1;
var second = 2;
var sum = first + second;

Übergreifendes Verknüpfen von Issues und Pull Requests

GFM unterstützt verschiedene Shortcodeformate, um Links zu Issues und Pull Requests zu vereinfachen. Die einfachste Möglichkeit diesbezüglich ist das #ID-Format wie #3602. GitHub passt automatisch längere Links an dieses Format an, wenn Sie sie einfügen. Sie können auch zusätzliche Konventionen befolgen, etwa wenn Sie mit anderen Tools arbeiten oder andere Projekte bzw. Branches angeben möchten.

Verweistyp	Unformatierter Verweis	Kurzlink
URL des Issues oder Pull Requests	https://github.com/desktop/desktop/pull/3602	#3602
# und Nummer des Issues oder des Pull Requests	#3602	#3602
GH- und Nummer des Issues oder Pull Requests	GH-3602	GH-3602
Username/Repository# und Nummer des Issues oder des Pull Requests	desktop/desktop#3602	desktop/desktop#3602

Weitere Informationen finden Sie im Artikel „Automatisch verlinkte Verweise und URLs“ in der zusammenfassenden Einheit am Ende dieses Moduls.

Verknüpfen bestimmter Commits

Sie können eine Verknüpfung mit einem Commit erstellen, indem Sie entweder die ID einfügen oder einfach seinen Secure Hash Algorithm (SHA) verwenden.

Verweistyp	Unformatierter Verweis	Kurzlink
Commit-URL	https://github.com/desktop/desktop/commit/
8304e9c271a5e5ab4fda797304cd7bcca7158c87	8304e9c
SHA	8304e9c271a5e5ab4fda797304cd7bcca7158c87	8304e9c
User@SHA	desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87	desktop@8304e9c
Benutzername/Repository@SHA	desktop/desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87	desktop/desktop@8304e9c

Erwähnen von Benutzern und Teams

Wenn Sie ein @-Symbol gefolgt von einem GitHub-Benutzernamen eingeben, wird eine Benachrichtigung an diese Person über den Kommentar gesendet. Dies wir als „@mention“ (Erwähnung) bezeichnet, da Sie den einzelnen Benutzer erwähnen. Sie können mit @mention auch Teams innerhalb einer Organisation erwähnen.

@githubteacher

@githubteacher

Nachverfolgen von Aufgabenlisten

Sie können Aufgabenlisten innerhalb von Issues oder Pull Requests erstellen, indem Sie die folgende Syntax verwenden. Diese Listen können hilfreich sein, um Fortschritte zu verfolgen, wenn sie im Hauptteil eines Issues oder Pull Requests verwendet werden.

- [x] First task
- [x] Second task
- [ ] Third task

Slash-Befehle

Slash-Befehle können Zeit sparen, indem die für die Erstellung von Markdownelementen benötigte Eingabe reduziert wird.

Du kannst Slash-Befehle in jedem Beschreibungs- oder Kommentarfeld in Issues, Pull Requests oder Diskussionen verwenden, für die dieser Slash-Befehl unterstützt wird.

Befehl	BESCHREIBUNG
/code	Fügt einen Markdown-Codeblock ein. Du wählst die Sprache aus.
/details	Es wird ein reduzierbarer Detailbereich eingefügt. Du wählst den Titel und den Inhalt aus.
/saved-replies	Fügt eine gespeicherte Antwort ein. Du wählst aus den gespeicherten Antworten für dein Benutzerkonto aus. Wenn Sie %cursor% Ihrer gespeicherten Antwort hinzufügen möchten, platziert der Slash-Befehl den Cursor an dieser Position.
/table	Fügt eine Markdowntabelle ein. Du wählst die Anzahl der Spalten und Zeilen aus.
/tasklist	Fügt eine Aufgabenliste ein. Dieser Slash-Befehl funktioniert nur in einer Problembeschreibung.
/template	Zeigt alle Vorlagen im Repository an. Du wählst die einzufügende Vorlage aus. Dieser Slash-Befehl funktioniert für Issuevorlagen und eine Pull Request-Vorlage.

Weiter