Mibakus

Hausverwaltung für private Vermieter

Markdown

Markdown ist ein einfaches Text-Format zur Formatierung von Dokumanten. Es wird z.B. zum Schreiben der Wikipedia-Seiten benutzt. Die von Mibakus unterstützten Elemente werden in den folgenden Abschnitten beschrieben.

Zuätzlich erlaubt Mibakus noch das Einfügen von Stil-Informationen, mit denen z.B. Schriftgrößen oder Umbrüche gesteuert werden können sowie die Erweiterung von Tabellen um Tabellen-Stile.

Absätze

Ein Absatz besteht aus beliebig vielen beliebig langen Zeilen mit Text. Innerhalb eines Absatzes darf sich keine Leerzeile befinden, da Leerzeilen zum Beenden eines Absatzes benutzt werden. Der Umbruch erfolgt automatisch. Einzelne Worte oder kurze Textteile können durch Fettdruck hervorgehoben werden, indem sie mit ‘*’ eingeschlossen werden.

Überschriften

Überschriften sind einzelne Textzeilen, unter denen sich eine weitere Zeile befindet, die nur aus dem Zeichen ‘=’ oder dem Zeichen ‘-’ besteht. Das ‘=’ erzeugt eine Überschrift mit etwas größeren Zeichen.

Listen

Listen bestehen aus einem Absatz, bei dem die erste Zeile mit “* “ oder “1. ” beginnt. Ersteres beginnt eine Spielgelstrichliste, zweites eine Aufzählung. Für jeden neuen Punkt muss eine neue Zeile wieder mit demselben Prefix geschrieben werden.

Tabellen

Tabellen bestehen aus einer Überschriftenzeile, einer Ausrichtungszeile und beliebig vielen Zeilen mit Inhalt. In allen Tabellenzeilen werden die einzelnen Spalten durch ‘|’ getrennt. ‘|’ am Zeilenbeginn und -ende sind optional, wenn die Tabelle mehr als 2 Spalten hat.

In der Ausrichtungszeile enthält jede Spalte 3 oder mehr ‘-’. Davor und dahinter kann jeweils ein ‘:’ stehen. Steht das ‘:’ nur links oder nur rechts, gibt es die Ausrichtung der Spalte an, bei zwei ‘:’ wird der Spalteninhalt zentriert. Ohne ‘:’ ist die Ausrichtung undefiniert.

Einzelne Zellen kann man über mehrere Spalten strecken, indem am Zellenende mehr als ein ‘|’ gesetzt wird.

Beispiel

Im Folgenden findet sich ein Markdown-Text und seine Darstellung im Druck darunter.


Markdown-Beispiel
=================

Dieses ist ein Absatz.
Wie man sieht, wird der Umruch automatisch gemacht.
Man kann einfach jeden Satz auf einer neuen Zeile beginnen.
Längere Sätze, so wie diesen hier
kann man aber auch auf beliebig viele Zeilen verteilen.

Ein weiterer Absatz wird durch eine *Leerzeile* abgetrennt.

Spiegelstrichliste
----------

* Apfel
* Banane
* Ein Listeneintrag kann sich auch
über mehrere Zeilen erstrecken
* Zitrone

Aufzählung
----------

1. Messer
1. Gabel
5. Die Zahl am Zeilenanfang spielt keine Rolle

Tabelle
-------

| Tabelle  |  links   |  mittig  |  rechts |
|----------|:---------|:--------:|--------:|
| Zeile 1  | Text | mehr Text | 1,00 |
| Zeile 2  | Beschreibung | Noch eine Beschreibung | 2,00 |
| Dieser *fette Text* erstreckt sich über 3 Spalten ||| 3,00 |

Markdown-Beispiel