Markdown und Darstellung

Die Inhalte einer Knowledge Base werden in Markdown geschrieben.

Markdown dient dabei als Format für die Speicherung und Bearbeitung der Inhalte.

Speicherung

Ein Artikel kann beispielsweise als Datei gespeichert werden:

articles/
└── suspicious-links.md

Der Inhalt könnte so aussehen:

# Verdächtige Links

Nicht jeder Link in einer E-Mail ist vertrauenswürdig.

## Prüfen

Achte insbesondere auf:

- die Domain
- Schreibfehler
- unerwartete Weiterleitungen

Verarbeitung

Die Anwendung liest den Markdown-Inhalt und übergibt ihn an einen Markdown-Parser.

Markdown
   │
   ▼
Parser
   │
   ▼
HTML

Das erzeugte HTML wird anschließend auf der Webseite dargestellt.

Warum Markdown?

Markdown hat mehrere Vorteile:

• leicht lesbar
• einfach zu bearbeiten
• gut für Versionskontrolle geeignet
• unabhängig von der eigentlichen Darstellung
• unterstützt Überschriften, Listen, Tabellen, Links und weitere Elemente

Zukünftige Erweiterungen

Die Knowledge Base kann später weitere Eingabe- und Ausgabeformate unterstützen.

Beispielsweise:

Markdown → HTML
Markdown → Unicode
Markdown → PDF
Markdown → weitere Formate

Die aktuelle Knowledge Base verwendet zunächst Markdown als Eingabeformat und HTML als Darstellungsformat.