Markdown Basic Syntax
Markdown ist eine leichte Markup-Sprache mit einer einfachen Syntax, die es Ihnen ermöglicht, sich mehr auf den Inhalt zu konzentrieren als auf die Formatierung. Es verwendet einen lesbaren und schreibbaren einfachen Textformat, kann mit HTML gemischt werden und kann in HTML, PDF oder seinem eigenen .md Dateiformat exportiert werden.
Design Philosophy
Das Ziel von Markdown ist "Lesbarkeit und Einfachheit beim Schreiben."
Lesbarkeit ist das wichtigste. Eine Datei, die in Markdown geschrieben ist, sollte als einfacher Text veröffentlicht werden können und nicht so aussehen, als ob sie voller Tags oder Formatierungsanweisungen wäre.
Das primäre Designziel von Markdowns Syntax ist es, so lesbar wie möglich zu machen. Basierend auf diesem Ziel können Markdown-Dokumente als einfacher Text veröffentlicht werden, ohne so aussehen zu wie sie voller Tags oder Formatierungsanweisungen sind.
—— John Gruber
HTML Compatibility
Das Ziel von Markdowns Syntax ist es, eine für das Web geeignete Schreibsprache zu sein.
Markdown zielt nicht darauf, HTML zu ersetzen, noch ist es nahe an ihm. Seine Syntax ist beschränkt und deckt nur einen kleinen Teil der HTML-Tags ab.
Tags, die von Markdown nicht abgedeckt sind, können direkt im Dokument mit HTML geschrieben werden. Es gibt keine Notwendigkeit, zu markieren, ob es HTML oder Markdown ist; füge einfach die Tags hinzu.
Zum Beispiel, füge eine HTML-Tabelle in einer Markdown-Datei hinzu:
This is a regular paragraph.
<table>
<tr>
<td>Foo</td>
</tr>
</table>
This is another regular paragraph.
Automatic Special Character Conversion
In HTML-Dateien müssen zwei Zeichen besondere Behandlung benötigen: <
und &
.
<
wird für öffnende Tags verwendet&
wird für HTML-Entitäten verwendet
Markdown erlaubt Ihnen, diese Zeichen natürlich zu schreiben und behandelt die Konvertierung für Sie. Wenn das &
Sie verwenden, ist Teil einer HTML-Entität, wird es beibehalten; andernfalls wird es zu &
konvertiert.
Basic Syntax Elements
Markdowns grundlegende Syntax umfasst die folgenden Elemente:
Block-Elemente
- Überschriften - Verwende
#
um Überschriften verschiedener Ebenen zu erstellen - Absätze und Zeilenumbrüche - Textabsätze und Zeilenumbruchsregeln
- Blockzitate - Verwende
>
um Blockzitate zu erstellen - Listen - Geordnete und ungeordnete Listen
- Codeblöcke - Spezialformat für Codeanzeige
- Horizontale Regeln - Erstelle horizontale Linien
Inline-Elemente
- Fett und Kursivtext - Fett- und Kursivtext
- Links - Erstelle Hyperlinks
- Bilder - Füge Bilder ein
- Inline-Code - Inline-Code-Markierungen
Andere
- Escape-Zeichen - Escape-Sonderzeichen
- Autolinks - Automatische Linkerkennung
Syntax-Beispiel
Unten ist ein Beispiel, das verschiedene grundlegende Syntaxelemente enthält:
# My Document
This is an example of **bold text** and *italic text*.
## List Example
### Shopping List
- Apple
- Banana
- Orange
### Task List
1. Learn Markdown basics
2. Practice writing
3. Share with friends
> This is an example of a blockquote. Markdown makes writing simple and elegant.
This is an [example link to the homepage](/).
Code example:
You can also use inline code, such as console.log('Hello World')
.
Best Practices
Überschriften
- Verwende nur eine Überschrift 1 (
#
) pro Dokument - Halte Überschriftenlogik logisch; überspringe keine Ebenen
- Hinterlasse Leerzeilen vor und nach Überschriften
Listenformatierung
- Halte ungeordnete Listenzeichen konsistent (verwende nur
-
,*
oder+
) - Es gibt keine Notwendigkeit für Leerzeilen zwischen Listenelementen, außer es gibt mehrere Absätze
Links und Bilder
- Stelle Links mit aussagekräftigen Textbeschreibungen bereit
- Stelle Alt-Text für Bilder bereit
Codeanzeige
- Verwende Inline-Code für kurze Codes
- Verwende Codeblöcke für lange oder mehrzeilige Codes
- Gib die Sprache für Codeblöcke an, um Syntaxhervorhebung zu ermöglichen
Tool Support
Fast alle Markdown-Anwendungen unterstützen diese grundlegenden Syntaxelemente. Es können geringfügige Unterschiede zwischen verschiedenen Markdown-Prozessoren bestehen, aber die grundlegende Syntax ist universell.
Nächste Schritte
Nachdem Sie eine Übersicht über die grundlegende Markdown-Syntax haben, können Sie:
- Tiefer in jedes Syntaxelement eintauchen
- Überprüfe die Cheat Sheet für schnelle Referenz
- Lernen Sie erweiterte Syntax für mehr Funktionen
- Erkunden Sie erweiterte Verwendung und Best Practices
Lerne spezifische Syntaxelemente: