Markdown-Syntax – Grundlegendes Tutorial

Markdown’s syntax is intended for one purpose: to be used as a format for writing for the web.
John Gruber

John Gruber, der Autor von Markdown, hat die Formatierungssyntax von Markdown mit dem Ziel entwickelt, sie so lesbar wie möglich zu machen. Markdown ist eine einfache Auszeichnungssprache, mit der Sie einfachen Text formatieren können. Es ist eine Möglichkeit, Inhalte für das Web zu schreiben. Die Markdown-Sprache ist einfach zu erlernen; sie enthält nur wenige zusätzliche Zeichen, so dass Sie schnell schreiben können und weniger Fehler machen.

Grundlegende Markdown-Syntax

Dieser Artikel enthält Informationen über die wichtigsten Markdown-Elemente, Details und Beispiele der Markdown-Syntax. Eine vollständige Liste der Markdown-Syntax ist in der core Markdown specification und der GitLab Flavored Markdown Variante erklärt. Alle diese Funktionen werden von Aspose.HTML sofort unterstützt.

Kopfzeilen

Markdown unterstützt zwei Arten von Überschriften, Setext und atx: Um eine Überschrift im atx-Stil zu erstellen, fügen Sie Zeichen (#) am Anfang der Zeile ein. Die Anzahl der Zeichen sollte der Ebene der Überschrift entsprechen. Hinweis: Setzen Sie immer ein Leerzeichen zwischen die Zahlenzeichen (#) und den Namen der Überschrift.

Alternativ können Sie eine Überschrift im Setext-Stil erstellen, indem Sie in der Zeile unter dem Text eine beliebige Anzahl von ==-Zeichen für die Überschriftsebene 1 oder ---Zeichen für die Überschriftsebene 2 hinzufügen.

Markdown Syntax	HTML	Rendered
# This is a Heading level 1	<h1>This is a Heading level 1</h1>	This is a Heading level 1
## This is a Heading level 2	<h2>This is a Heading level 2</h2>	This is a Heading level 2
### This is a Heading level 3	<h3>This is a Heading level 3</h3>	This is a Heading level 3
###### This is a Heading level 6	<h6>This is a Heading level 6</h6>	This is a Heading level 6
This is a Heading level 1 ===================	<h1>This is a Heading level 1</h1>	This is a Heading level 1
This is a Heading level 2 - - - - - - - - - - - - - - - - - - -	<h2>This is a Heading level 2</h2>	This is a Heading level 2

Hervorhebung

Markdown behandelt Sternchen * und Unterstriche (_) als Indikatoren für die Hervorhebung. Um Text gleichzeitig fett und kursiv zu machen, fügen Sie drei Sternchen oder Unterstriche vor und nach dem Wort oder Satz hinzu. Um die Mitte eines Wortes fett und kursiv zu machen, fügen Sie drei Sternchen ohne Leerzeichen um die Buchstaben hinzu.

Markdown Syntax	HTML	Rendered
`single asterisks`	<em>single asterisks</em>	single asterisks
`_single underscores_`	<em>single underscores</em>	single underscores
`double asterisks`	<strong>double asterisks</strong>	double asterisks
`__ double underscores__`	<strong>double underscores</strong>	double underscores
`*Bold and Italic*`	<strong><em>Bold and Italic</em></strong>	*Bold and Italic*
`___Bold and Italic___`	<strong><em>Bold and Italic</em></strong>	*Bold and Italic*
`Make text bold*and*italic at the same time`	Make text bold<strong><em>and</em></strong>italic at the same time	Make text boldanditalic at the same time

Blockanführungszeichen

Die Sprache Markdown verwendet das Zeichen > im E-Mail-Stil für Blockquote. Um Blockquote zu erstellen, sollten Sie also ein Zeichen > vor die erste Zeile eines fest umschlossenen Absatzes setzen. Wenn ein Blockzitat mehrere Absätze enthält, fügen Sie ein > in den Leerzeilen zwischen den Absätzen ein. Außerdem können Blockquotes andere Markdown-Elemente enthalten, darunter Überschriften, Hervorhebungen, Listen oder Codeschnipsel: Betrachten wir einige Anwendungsbeispiele:

Markdown Syntax

Rendered

> Markdown is intended to be as easy-to-read and easy-to-write as is feasible.

> ## This is a header.
> 
> 1.   This is the first list item.
> 2.   This is the second list item.
> 
> Here’s some example code:
> 
>    using var document = new HTMLDocument();

Markdown-Codeblöcke

Code

Um einen Codeabschnitt im Artikeltext zu kennzeichnen, umschließen Sie ihn mit Anführungszeichen (`):

Markdown Syntax	HTML	Rendered
Load the HTML file using `HTMLDocument` class	Load the HTML file using <code>HTMLDocument</code> class	Load the HTML file using `HTMLDocument`class
`Use code in your Markdown file.`	<code>Use code in your Markdown file.</code>	`Use code in your Markdown file.`

Code-Blöcke

Um einen Codeblock in Markdown zu erstellen, muss jede Zeile des Blocks um mindestens 4 Leerzeichen oder 1 Tabulator eingerückt werden. In diesem Beispiel werden die führenden Leerzeichen durch Punkte gekennzeichnet: (⋅):

Markdown Syntax	HTML	Rendered
This is a normal paragraph.	<p>This is a normal paragraph.</p>	This is a normal paragraph.
⋅⋅⋅⋅This is a Markdown code block.	<pre>This is a Markdown code block.</pre>	This is a Markdown code block.

Verzeichnisse

Unsortierte Listen

Markdown unterstützt geordnete (nummerierte) und ungeordnete (Aufzählungslisten) Listen. In ungeordneten Listen werden Sternchen, Pluszeichen und Bindestriche als Listenmarkierungen verwendet. Beginnen Sie Zeilen mit *, + oder -. Um eine verschachtelte Liste zu erstellen, rücken Sie ein oder mehrere Elemente ein:

Markdown Syntax	HTML	Rendered
- First item - Second item - Third item - Fourth item	<ul> <li>First item</li> <li>Second item</li> <li>Third item</li> <li>Fourth item</li> </ul>	First item Second item Third item Fourth item
* First item * Second item * Blue * Black	<ul> <li>First item</li> <li>Second item</li> <li>Third item</li> <li>Fourth item</li> </ul>	First itemd Second item Third item Fourth item
+ First item + Second item + Third item + Fourth item	<ul> <li>First item</li> <li>Second item</li> <li>Third item</li> <li>Fourth item</li> </ul>	First itemd Second item Third item Fourth item

Sortierte Listen

Um eine sortierte Liste zu erstellen, fügen Sie Zeilenelemente mit Zahlen gefolgt von Punkten hinzu. Die Liste sollte mit der Zahl Eins beginnen. Andere Zahlen, die Sie zur Markierung der Liste verwenden, haben keinen Einfluss auf die HTML-Ausgabe von Markdown.

Markdown Syntax

HTML

Rendered

1. Red
1. Green
1. Blue
1. Black

<ol>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
<li>Black</li>
</ol>

Red
Green
Blue
Black

1. Red
2. Green
3. Blue
4. Black

<ol>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
<li>Black</li>
</ol>

Red
Green
Blue
Black

1. Red
5. Green
3. Blue
8. Black

<ol>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
<li>Black</li>
</ol>

Red
Green
Blue
Black

Bilder

Die Markdown-Syntax für Inline-Bilder sieht wie folgt aus:

![Alt text for image](/path/to/img.png)
Example:
![Text "Ananuri Fortress Complex in Georgia"](georgia-castle.png)

Fügen Sie ein Ausrufezeichen (!) ein, gefolgt von einem Alt-Text in eckigen Klammern und der URL oder dem Pfad zu dem Bild in Klammern. Dabei ist Alt-Text für Bild eine kurze Beschreibung des Bildes und /path/to/img.png ein relativer Pfad zu dem Bild. Alternativer Text ist nützlich, wenn das Bild nicht gerendert werden kann. Die gerenderte Ausgabe für das Beispiel georgia-castle.png sieht wie folgt aus:

Text “Festungskomplex Ananuri in Georgien”

Erweiterte Markdown-Syntax

Links

Um einen Link zu erstellen, schreiben Sie den Linktext in eckige Klammern und geben dann die URL in Klammern an. Die Linksyntax sieht wie folgt aus:

verwenden Sie Markdown Converter, um Markdown-Dateien in eine Vielzahl von gängigen Formaten zu konvertieren

Der gerenderte Linktext sieht wie folgt aus:

Verwenden Sie Markdown Converter, um Markdown-Dateien in eine Vielzahl von gängigen Formaten zu konvertieren.

URLs und E-Mail-Adressen

Um eine URL oder E-Mail-Adresse schnell in einen Link zu verwandeln, schreiben Sie sie in spitze Klammern:

1<https://docs.aspose.com/html/net/converting-between-formats/>
2<html@example.com>

Die gerenderten Links zur URL und zur E-Mail-Adresse sehen wie folgt aus:

https://docs.aspose.com/html/net/converting-between-formats/

html@example.com

Bild als Link

Um einen Link zu einem Bild hinzuzufügen, schließen Sie das Markdown für das Bild in Klammern ein und fügen dann den Link in Klammern hinzu. Die Markdown-Syntax für ein Bild als Link sieht wie folgt aus:

1 [![Text "MD to PDF Converter"](/html/images/banner/md-to-pdf.png)](https://products.aspose.app/html/de/conversion/md-to-pdf)

Das gerenderte Bild als Link sieht wie folgt aus:

Syntax für Markdown-Tabellen

Tabellen sind oft der beste Weg, um Daten zu präsentieren, aber die Formatierung von Tabellen in Markdown ist eine der schwierigsten. Eine Tabelle in Markdown besteht aus zwei Teilen: der Kopfzeile und den Datenzeilen in der Tabelle. Tabellen werden mit Pipes (|) und Bindestrichen (-) erstellt. Verwenden Sie drei oder mehr Bindestriche (- - -), um die Überschrift jeder Spalte zu erstellen, und verwenden Sie Pipes (|), um jede Spalte zu trennen. Die Doppelpunkte (:) werden verwendet, um Zellinhalte auszurichten. Die Doppelpunkte links neben dem Bindestrich bewirken, dass die Spalte linksbündig ist usw.

Hier ist ein Beispiel für die Syntax einer Markdown-Tabelle:

1| Header 1       | Header 2           | Header 3       |
2| :------------- | :----------------: | -------------: |
3| Cell Content 1 | Cell Content 2     | Cell Content 3 |
4| Text           | Some long data here| Data           |

The rendered table looks like this:

Header 1	Header 2	Header 3
Cell Content 1	Cell Content 2	Cell Content 3
Text	Some long data here	Data

mit GitLab Flavored Markdown können Sie einfache, leicht zu lesende Tabellen erstellen. Sie können Tabellen ganz einfach mit Markdown-Syntax versehen, z. B. fett, kursiv, Codeblöcke, HTML-Tags und mehr.

die Bibliothek Aspose.HTML for .NET bietet eine Markdown-Parsing-API für die C#-Plattform. Sie können MD-Dateien programmatisch erstellen, bearbeiten, speichern, zusammenführen, in andere Formate konvertieren und Links, Listen, Codeblöcke, Bilder und andere Elemente in Markdown-Dateien einfügen.

Markdown in Bild konvertieren SVG-Konverter