Dokumente layouten mit Markdown

In Form bringen

Zum Schreiben von technischer Dokumentation können Entwickler und Administratoren zwischen einer Vielzahl an unterschiedlichen Tools auswählen. Der Open-Source-Tipp in diesem Monat zeigt, wie Sie mit Hilfe von Markdown und pandoc Ihre Texte in viele unterschiedliche Formate transformieren und nebenbei auch noch anspruchsvolle Präsentationen erstellen.
Auch kleine Unternehmen stehen vor großen Herausforderungen in Sachen IT. Doch oft haben sie verhältnismäßig weniger Budget und Personal zur Verfügung, um ... (mehr)

Klassischerweise kommen für das Erstellen von Dokumentationen oder Anleitungen Textbearbeitungsprogramme wie beispielsweise Microsoft Word, Apple Pages oder das Open-Source-Tool LibreOffice zum Einsatz. All diese Programme haben gemeinsam, dass unterschiedliche Elemente eines Dokuments miteinander vermischt werden. So besteht eine gute Dokumentation oder Anleitung ja nicht nur aus reinem Text, sondern enthält auch Bilder, Grafiken, Tabellen, Listen und andere Elemente. Dies bedeutet im Umkehrschluss, dass beim Schreiben nicht nur auf den eigentlichen Inhalt des Dokuments zu achten ist, die einzelnen Elemente müssen auch vom Layout her gut aufeinander abgestimmt sein.

Dabei ist es ein wenig verwunderlich, dass dieses What-you-see-is-what-you-get-Prinzip (WYSIWYG) immer noch großen Anklang findet, da sich in anderen Bereichen eine Trennung zwischen dem Inhalt eines Dokuments und dem Layout schon seit langer Zeit durchgesetzt hat – beispielsweise in der Webentwicklung. Hier würde niemand mehr auf die Idee kommen, das Layout einer Webseite zusammen mit dem Inhalt der Seite zu vermischen. Stattdessen kommt für das Layout ein Stylesheet zum Einsatz, das zumeist als CSS-Datei (Cascading Style Sheet) [1] vorliegt. Um ein Layout für die Webseite zu erzeugen, ist somit nur noch das CSS anzupassen, ohne irgendwas am Inhalt der Seite ändern zu müssen.

Textsatzsysteme TeX, LaTeX und Markdown

Wer eine solche logische Trennung zwischen Inhalt und Darstellung auch bei der Bearbeitung von Texten einsetzen möchte, kann beispielsweise auf TeX [2] oder LaTeX [3] zurückgreifen. Hierbei handelt es sich allerdings um komplexe Textsatzsysteme, deren Syntax nicht unbedingt eingängig ist und eine gewisse Einarbeitungszeit voraussetzt. Wobei es sich bei LaTeX strenggenommen eigentlich auch nur um eine Sammlung von Makros handelt, die die Benutzung von TeX vereinfachen sollen.

Wesentlich

...

Der komplette Artikel ist nur für Abonnenten des ADMIN Archiv-Abos verfügbar.

comments powered by Disqus

Artikel der Woche

Eigene Registry für Docker-Images

Wer selber Docker-Images herstellt, braucht auch eine eigene Registry. Diese gibt es ebenfalls als Docker-Image, aber nur mit eingeschränkter Funktionalität. Mit einem Auth-Server wird daraus ein brauchbares Repository für Images. (mehr)
Einmal pro Woche aktuelle News, kostenlose Artikel und nützliche ADMIN-Tipps.
Ich habe die Datenschutzerklärung gelesen und bin einverstanden.

Konfigurationsmanagement

Ich konfiguriere meine Server

  • von Hand
  • mit eigenen Skripts
  • mit Puppet
  • mit Ansible
  • mit Saltstack
  • mit Chef
  • mit CFengine
  • mit dem Nix-System
  • mit Containern
  • mit anderer Konfigurationsmanagement-Software

Ausgabe /2022