From 9c429a177555ee9c7ef2298a91149cd02180c3c6 Mon Sep 17 00:00:00 2001 From: Jake <j.vondoemming@stud.uni-goettingen.de> Date: Mon, 12 Sep 2022 03:07:57 +0200 Subject: [PATCH] started documenting markdown syntax --- docs/content/mdsyntax.de.md | 102 ++++++++++++++++++++++++++++++++++-- 1 file changed, 99 insertions(+), 3 deletions(-) diff --git a/docs/content/mdsyntax.de.md b/docs/content/mdsyntax.de.md index e330934..7c31115 100644 --- a/docs/content/mdsyntax.de.md +++ b/docs/content/mdsyntax.de.md @@ -3,10 +3,106 @@ title: "Markdown Syntax" prio: 4 --- +:::info +Die Markdown Syntax baut auf der [Markdown Syntax von Pandoc](https://pandoc.org/MANUAL.html#pandocs-markdown) auf. Es sind einige Extensions aktiviert, um die Syntax möglichst ähnlich zur [Hedgedoc Markdown Syntax](https://pad.gwdg.de/features) 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: +```markdown +Ich bin ein *Markdown* Beispiel. +``` + +:::success +Ich bin ein *Markdown* Beispiel. +::: + +## 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. + +```markdown +Dies ist der erste Paragraph. + +Dies ist der zweite Paragraph und dieser Paragraph +beinhaltet sogar einen Zeilenumbruch. +``` + +:::success +Dies ist der erste Paragraph. + +Dies ist der zweite Paragraph und dieser Paragraph +beinhaltet sogar einen Zeilenumbruch. +::: + +## Überschriften + + +Es gibt zwei Arten Überschriften zu schreiben: [Setext](#setext) und [ATX](#atx). + +In Überschriften kann [Inlinemarkup](#inlinemarkup) verwendet werden. + +Eine Leerzeile vor oder nach einer Überschrift ist nicht notwendig. + :::warning -TODO Markdown Syntax konkret dokumentieren! +Jede Seite wird automatisch mit einer Level 1 Überschrift aus dem Titel generiert. +Entsprechend sollten die meisten Dokumente nur Level 2-6 Überschriften verwenden! ::: +:::warning +Überschriften haben semantische Bedeutung welche von Browsern, Bots und Screenreadern interpretiert und verwendet wird. +Überschriften sollten deshalb _niemals_ verwendet werden um Text einfach nur **fettgedruckt** oder in einer bestimmten Schriftgröße zu schreiben weil es ja "gut aussehen würde". +::: + +### 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). + +```markdown +Eine Level 1 Überschrift +======================== + +Eine Level 2 Überschrift +------------------------ +``` + +:::success +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. + +```markdown +# Eine Level 1 Überschrift +## Eine Level 2 Überschrift +### Eine Level 3 Überschrift ### +#### Eine Level 4 Überschrift +##### Eine Level 5 Überschrift +###### Eine Level 6 Überschrift +``` + +:::success +# Eine Level 1 Überschrift +## Eine Level 2 Überschrift +### Eine Level 3 Überschrift ### +#### Eine Level 4 Überschrift +##### Eine Level 5 Überschrift +###### Eine Level 6 Überschrift +::: + +:::danger +TODO continue https://pandoc.org/MANUAL.html#extension-header_attributes +::: -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. -Einen Überblick über die Hedgedoc Markdown Syntax gibt es [hier](https://pad.gwdg.de/features) +## Inlinemarkup -- GitLab