Dokumentation Fachgruppenwebseite

Markdown Syntax

Die Markdown Syntax baut auf der Markdown Syntax von Pandoc auf. Es sind einige Extensions aktiviert, um die Syntax möglichst ähnlich zur Hedgedoc Markdown Syntax zu machen.

Die vollständige Markdown Syntax die verwendet werden kann ist also sehr umfangreich. Dieses Dokument sollte alle Features und Schreibweisen aufzeigen.

Markdowncodebeispiele zusammen mit den entsprechenden Ergebnissen die generiert wurden sehen in diesem Dokument wie folgt aus:

Ich bin ein *Markdown* Beispiel.

Ich bin ein Markdown Beispiel.

Inhaltsverzeichnis

Ein Paragraph mit einzigem Inhalt [TOC] generiert ein Inhaltsverzeichnis.

[TOC]

Paragraphen

Ein Paragraph besteht aus einer oder mehr Zeilen an Text gefolgt von einer oder mehreren Leerzeilen.
Ein Zeilenumbruch in einem Paragraphen wird, wie in Hedgedoc auch, direkt auf der Webseite als Zeilenumbruch übernommen.

Dies ist der erste Paragraph.

Dies ist der zweite Paragraph und dieser Paragraph
beinhaltet sogar einen Zeilenumbruch.

Dies ist der erste Paragraph.

Dies ist der zweite Paragraph und dieser Paragraph
beinhaltet sogar einen Zeilenumbruch.

Überschriften

Überschriften werden genutzt um ein Dokument zu strukturieren.

Es gibt zwei Arten Überschriften zu schreiben: Setext und ATX.
In Überschriften kann Inlinemarkup verwendet werden.
Eine Leerzeile vor oder nach einer Überschrift ist nicht notwendig.

Nutzungsinformationen

Setext

Setext-Style Überschriften bestehen jeweils aus einer Zeile mit dem Überschriftstext gefolgt von einer Zeile mit =-Symbolen (für eine Level 1 Überschrift) oder --Symbolen (für eine Level 2 Überschrift).

Eine Level 1 Überschrift
========================

Eine Level 2 Überschrift
------------------------

Eine Level 1 Überschrift

Eine Level 2 Überschrift

ATX

ATX-Style Überschriften bestehen jeweils aus einer Zeile mit ein bis sechs #-Symbolen gefolgt von mindestens einem Leerzeichen, dem jeweiligen Überschriftstext und einer optionalen Menge an weiteren #-Symbolen.
Die Anzahl der #-Symbole am Anfang der Zeile gibt das Level an.

# Eine Level 1 Überschrift
## Eine Level 2 Überschrift
### Eine Level 3 Überschrift ###
#### Eine Level 4 Überschrift
##### Eine Level 5 Überschrift
###### Eine Level 6 Überschrift

Eine Level 1 Überschrift

Eine Level 2 Überschrift

Eine Level 3 Überschrift

Eine Level 4 Überschrift

Eine Level 5 Überschrift
Eine Level 6 Überschrift

Identifikator, Attribute und Klassen

Am Ende der Zeile mit dem Überschriftentext kann man auch optionale Metadaten hinzugefügen.

Dafür schreibt man leerzeichengetrennt in geschweiften Klammern die folgenden Dinge:

In den meisten Fällen wird maximal der Identifikator benötigt.
Der Identifaktor kann zum verlinken des entsprechenden Abschnittes verwendet werden.

#### Eine Überschrift {#bspueberschrift}
#### Eine andere Überschrift {#anderebspueberschrift .mit-klassen .foobar}
#### Nich Nummeriert und nicht im Inhaltsverzeichnis {- .unlisted}

Eine Überschrift

Eine andere Überschrift

Nich Nummeriert und nicht im Inhaltsverzeichnis

Falls kein Identifikator für eine Überschrift gesetzt wurde, wird automatisch einer aus dem Überschriftentext generiert.

Inlinemarkup

Es gibt einige Inlinemarkups.
Die simplesten sind im folgenden Beispiel aufgezeigt.

Normaler Text
**Fettgedruckter Text**
__Fettgedruckter Text__
*Kursiv gesetzter Text*
_Kursiv gesetzter Text_
~~Durchgestichener Text~~

"Schöne doppelte Anführungszeichen"
'Schöne einfache Anführungszeichen'

Superscript: 19^th^
Subscript: H~2~O
Hinweis: Superscript und Subscript ~funktioniert nur~ ohne ^Leerzeichen dazwischen^. Es sei denn ~man\ escaped~ ^die\ Leerzeichen^.

Geviertstriche werden mit zwei oder drei Minuszeichen gemacht:
Schön---nein, unfassbar!
Während 1980--1988.

***Gemischte*** ~~_Syntax_~~ __~geht~__ **_^auch^_**

Normaler Text
Fettgedruckter Text
Fettgedruckter Text
Kursiv gesetzter Text
Kursiv gesetzter Text
Durchgestichener Text

„Schöne doppelte Anführungszeichen“
‚Schöne einfache Anführungszeichen‘

Superscript: 19th
Subscript: H2O
Hinweis: Superscript und Subscript ~funktioniert nur~ ohne ^Leerzeichen dazwischen^. Es sei denn man escaped die Leerzeichen.

Geviertstriche werden mit zwei oder drei Minuszeichen gemacht:
Schön—nein, unfassbar!
Während 1980–1988.

Gemischte Syntax geht auch

"Strong"     :{"handler" : InlineSimple, "etype":"strong"     },
"Emph"       :{"handler" : InlineSimple, "etype":"emph"       },
"Underline"  :{"handler" : InlineSimple, "etype":"underline"  },
"Strikeout"  :{"handler" : InlineSimple, "etype":"strikeout"  },
"Superscript":{"handler" : InlineSimple, "etype":"superscript"},
"Subscript"  :{"handler" : InlineSimple, "etype":"subscript"  },
"SmallCaps"  :{"handler" : InlineSimple, "etype":"smallcaps"  },
"Quoted"     : InlineQuoted,
"SoftBreak"  : InlineSoftBreak,
"LineBreak"  : InlineLineBreak,

Die restlichen Inlinemarkups sind in den folgenden Unterabschnitten genauer beschrieben.

"Link"       : InlineLink,

Bilder

"Image"      : InlineImage,

👉 Emoji 👈

Es gibt Emojis! 😃
Eine Auflistung aller 1855 möglichen Emojis findest du in der Emojiliste.

Fühl dich gedrückt :hugs: :hearts:

Fühl dich gedrückt 🤗 ♥️

Mathe

"Math"       : InlineMath,

Code

Fußnoten

"Note"       : InlineFootnote,

Backslash-Escape

Außer in Codeblöcken oder Inline Code, werden alle Zeichensetzungen oder Leerzeichen, welche direkt auf ein Backslash folgen, als Literale gelesen.

*Dieser Text ist kursiv.*
\*Dieser Text hat Sternchen.\*
*\*Dieser Text hat Sternchen und ist kursiv.\**

Dieser Text ist kursiv.
*Dieser Text hat Sternchen.*
*Dieser Text hat Sternchen und ist kursiv.*

Nonbreaking Space

Alerts

TODO

Zitate

"BlockQuote"    : BlockQuote,

Listen

Ungeordnete Listen

"BulletList"    : BlockBulletList,

Geordnete Listen

"OrderedList"   : BlockOrderedList,

Aufgabenlisten

Beispiellisten

Listen beenden

Definitionslisten

"DefinitionList": BlockDefinitionList,

Codeblöcke

"CodeBlock"     : BlockCode,

Horizontale Trennlinien

"HorizontalRule": BlockHorizontalRule,

Tabellen

"Table"         : BlockTable,

Kommentare

Kommentare können einfach mit HTML Kommentaren gemacht werden.

Hallo Welt
<!-- Ich bin unsichtbar. Achtung: Es kann zusätzliche Zeilenumbrüche geben. -->
Guten Tag

Hallo Welt

Guten Tag

Divs und Spans

"Div"           : BlockContainer,
"Span"       : InlineContainer,

Sachen nebeneinander darstellen

Rohes HTML

"RawBlock"      : BlockRaw,
"RawInline"  : InlineRaw,

Abbreviations

Nicht unterstützt.

Line Blocks