MyST-Markdown Kurzanleitung

MyST-Markdown Kurzanleitung#

Was ist Markdown?#

Markdown (MD) ist eine Auszeichnungssprache, die entwickelt wurde, um Text mit einfacher, gut lesbarer Syntax zu formatieren. Im Gegensatz zu komplexeren Formaten wie HTML oder LaTeX bleibt der Quelltext nahezu so lesbar wie der fertige Text. Formatierungen wie Überschriften, Listen, Hervorhebungen oder Links werden durch wenige, intuitive Zeichen dargestellt (z. B. #, *, []()). Markdown wird häufig für Dokumentationen, Webseiten, wissenschaftliche Texte und Notebooks verwendet, da es einfach zu schreiben, plattformunabhängig und gut automatisierbar ist. MyST (Markedly Structured Text) erweitert Markdown um Funktionen für wissenschaftliches und technisches Schreiben. Es ergänzt Markdown um Direktiven, Rollen, Querverweise, Mathematik und strukturierte Metadaten.

Tab. 121 Markdown-Syntaxübersicht#

Funktion

Syntax

Alternative

Ergebnis

Einfache Hervorhebung

*Italic*

Italic

Starke Hervorhebung

**Bold**

Bold

Überschrift Ebene 1

# Heading 1

alt text

Überschrift Ebene 2

## Heading 2

alt text

Link

[Link](http://a.com)

Link

Zitat

>   Blockquote

Blockquote

Liste

 
-   List
-   List
-   List

  • List

  • List

  • List

Aufzählung

 
1.   One
2.   Two
3.   Three

  1. One

  2. Two

  3. Three

Defintionsliste

 
Begriff
:   Die Erklärung
Begriff

Die Erklärung

Horizontale Linie

---

alt text

Inline-Code

`Inline code`

Inline code

Bild

![Image](a.png)

 
:::{image} a.png
:::

Image

Bild mit Beschreibung

 
:::{figure} a.png

Beschreibung
:::
../../../_images/a.png

Fig. 237 Beschreibung#

Mathematik

 
$I = \frac{U}{R}$

{math}`I = \frac{U}{R}`

\(I = \frac{U}{R}\)

Basis-Markdown#

Beispiel: Basis-Markdown

Überschrift Ebene 1

Überschrift Ebene 2

Überschrift Ebene 3

hervorgehoben stark hervorgehoben

  • Liste

  • Liste

  1. Aufzählung

  2. Aufzählung

Link

Rollen (Inline-Elemente)#

Rollen erweitern die Inline-Syntax. Sie werden innerhalb einer Zeile verwendet.

Allgemeine Syntax:

Text

Tab. 122 Beispiele für Rollen#

Funktion

Rolle

Beispiel

Abkürzung

abbr

{abbr}`MRT (Magnetresonanztomographie)`

Querverweis

ref

{ref}`Beschreibung <label>`

Verweis auf Term

term

{term}`term`

Bild

image

{image}`a.png`

Mathematik

math

{math}`E = mc^2`

 

Direktiven (Block-Elemente)#

Direktiven sind strukturierte Blockelemente. Sie beginnen meist mit einem Fence und einem Namen in geschweiften Klammern.

Allgemeine Syntax:

Häufig verwendete Direktiven sind:

  • image

  • figure

  • math

  • admonition

Beispiel: Abbildung

../../../_images/a.png

Fig. 238 Bildunterschrift#

../../../_images/a.png

Fig. 239 Bildunterschrift#

Definitionslisten#

Definitionslisten dienen zur Darstellung von Begriffen mit zugehörigen Definitionen. Sie eignen sich besonders für Glossare, Verzeichnisse oder strukturierte Erklärungen. Eine Definitionsliste besteht aus einem Begriff (Term) und einer oder mehreren Definitionen:

Begriff

Definition

Beispiel: Definition List

Reanimation

Wiederbelebungsmaßnahmen zur Wiederherstellung von Atmung und Kreislauf

Hypoxie

Sauerstoffmangel im Gewebe

Reanimation

Wiederbelebungsmaßnahmen zur Wiederherstellung von Atmung und Kreislauf

Hypoxie

Sauerstoffmangel im Gewebe

Beispiel: Mehrzeilige Definition

Sepsis

Lebensbedrohliche Organdysfunktion infolge einer dysregulierten Immunantwort auf eine Infektion. Sie kann verschiedene Ursachen haben.

Man kann ihr auch einen weiteren Absatz widmen.

Sepsis

Lebensbedrohliche Organdysfunktion infolge einer dysregulierten Immunantwort auf eine Infektion. Sie kann verschiedene Ursachen haben.

Man kann ihr auch einen weiteren Absatz widmen.

Beispiel: Mehrere Definitionen

Schock

Lebensbedrohlicher Zustand mit unzureichender Gewebeperfusion

Psychische Reaktion auf belastendes Ereignis

Schock

Lebensbedrohlicher Zustand mit unzureichender Gewebeperfusion

Psychische Reaktion auf belastendes Ereignis

Hinweise:

  • Der Begriff steht in einer eigenen Zeile

  • Die Definition beginnt mit :  

  • Einrückung ist entscheidend für die Struktur

  • Mehrere Definitionen sind möglich

Querverweise#

Mit Labels können Abschnitte, Abbildungen oder Gleichungen referenziert werden.

Label vor Überschrift setzen#

Erzeugt das Label Reanimation vor der eigentlichen Überschrift:

Referenz erzeugen

Direktive (z.B. Bild) benennen#

../../../_images/a.png

Fig. 240 Bildunterschrift#

Referenz erzeugen#

Siehe Referenz-erzeugen, oder siehe Beipiel zum Erzeugen einer Referenz.

Beispiel: Querverweis

Siehe Referenz-erzeugen, oder siehe Beipiel zum Erzeugen einer Referenz.

Siehe Referenz-erzeugen, oder siehe Beipiel zum Erzeugen einer Referenz.

Mathematik#

Mathematik kann inline oder als Block dargestellt werden.

Inline#

\(E = mc^2\)

Block#

\[E = mc^2\]

Beispiel: Mathematik

\[E = mc^2\]
\[E = mc^2\]

Fußnoten#

Text mit Fußnote[1]

Beispiel: Fußnote

Text mit Fußnote[1]

Text mit Fußnote[1]

Frontmatter#

Frontmatter enthält Metadaten und steht am Anfang der Datei.

Beispiel: Frontmatter

Auf dieser Seite ...