Skip to content
Snippets Groups Projects
Commit 8df13a7f authored by Rainer Perske's avatar Rainer Perske
Browse files

Update README.md

parent f6c1ad81
No related branches found
No related tags found
No related merge requests found
......@@ -38,22 +38,27 @@ Markdown-Syntax-Übersicht:
<https://www.heise.de/mac-and-i/downloads/65/1/1/6/7/1/0/3/Markdown-CheatSheet-Deutsch.pdf>
(ohne Fußnoten, aber mit Tabellen)
Da die Texte auch als Plaintext in E-Mails eingebettet werden, sollten folgende
Empfehlungen eingehalten werden, damit die E-Mails besser aussehen:
Da die Texte nicht nur von verschiedenen Markdown-Parsern verstanden werden
müssen, sondern zusätzlich auch als Plaintext in E-Mails eingebettet werden
und dort gut aussehen sollen, sollten folgende Empfehlungen eingehalten werden:
* Die Zeilenlänge sollte weniger als 80 Zeichen betragen. (Der in zivgitlab
eingebaute Editor markiert die 80 Spalten mit einer vertikalen Linie.)
* Alle Absätze sollten durch Leerzeilen getrennt werden, auch wenn es nicht
syntaktisch notwendig ist.
* Auf Tabulatorzeichen sollte verzichtet werden.
* Absätze aller Art sollten durch Leerzeilen getrennt werden, auch wenn es
nicht syntaktisch notwendig ist.
* Bei ungeordneten Aufzählungen, insbesondere wenn sie verschachtelt werden,
sollte die Einrückung immer genau vier Zeichen tief sein: `_ _ * _`
Auch der Spiegelpunkt (Stern, Plus, Minus) sollte eingerückt sein.
* Einrückungen sollten immer genau vier Zeichen tief sein.
* Auch Spiegelpunkte und Zitatzeichen sollten eingerückt sein:
`␣␣*␣` oder `␣␣+␣` oder `␣␣-␣` oder `␣␣>␣`
* Bei geordneten Aufzählungen sollten ebenfalls vier Zeichen Einrückung
verwendet werden, die Zahl aber linksbündig bleiben (einzelne Markdown-
Parser scheinen das zu verlangen): `1 . _ _`
* Geordnete Aufzählungen sollten linksbündig korrekt durchnummeriert sein:
`1.␣␣` bis `9.␣␣` und `1 0.␣ . _` bis `9 9 . _`
* Überschriften sollten durch Unterstreichung (nicht `#`) markiert werden.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment