GitHub Markdown Tipp

Auf GitHub kann man die Readme-Dateien bekanntlich in Markdown verfassen. Da ich mich noch mit Markdown vertraut mache, hatte ich so meine Anlaufschwierigkeiten.

Vor das erste Problem stellte mich ein einfacher Zeilenumbruch. Ein einfaches return oder ein \n brachten leider nicht das gewünschte Ergebnis. Nach etwas Suchen bin ich dann schließlich fündig geworden. In Markdown erzeugen zwei oder mehr Leerzeichen am Ende einer Zeile einen Zeilenumbruch.

Das zweite Problem war die Darstellung des #-Zeichens am Ende einea Markdown-Headers. In Markdown wird ein Header mit dem #-Zeichen eingeführt. Endet der Satz ebenfalls mit einem #-Zeichen (z.B. Examples in C#), wird es nicht angezeigt. Abhilfe schafft auch hier ein Leerzeichen am Ende der Zeile und der Satz wird korrekt angezeigt.