Tutorial: Markdown-Notation für die Pflege von Inhalten im Kirby CMS

1. Einführung in Markdown

Markdown wurde entwickelt, um das Schreiben von strukturiertem Text einfach zu machen. Es verwendet einfache Textzeichen, um Formatierungen wie Überschriften, Fett- und Kursivdruck, Listen und Links zu erstellen. Der große Vorteil ist, dass der Inhalt sowohl in seiner Rohform lesbar bleibt als auch problemlos in HTML umgewandelt werden kann.

2. Grundlegende Markdown-Syntax

Hier sind einige grundlegende Markdown-Elemente, die Du in Deinen Kirby-Inhalten verwenden kannst:

Überschriften

# Überschrift 1
## Überschrift 2
### Überschrift 3

Fett und Kursiv

**Fetter Text**
*Kursiver Text*

Listen

Ungeordnete Liste

- Ein Punkt
- Noch ein Punkt

Geordnete Liste

1. Erster Punkt
2. Zweiter Punkt

Links

[Husken Medien GmbH](https://www.huskenmedien.de)

Bilder

![Alt-Text](https://www.example.com/bild.jpg)

3. Markdown in Kirby verwenden

Kirby unterstützt Markdown nativ, was bedeutet, dass Du Markdown direkt in Deinen Textfeldern im Panel verwenden kannst. Hier ist ein einfaches Beispiel, wie Du Markdown in einem Feld verwenden kannst:

Blueprint (default.yml):

title: Standardseite

sections:
  content:
    type: fields
    fields: 
      text:
        label: Text
        type: textarea

Wenn Du jetzt Inhalte für eine Seite mit diesem Blueprint erstellst, kannst Du im text-Feld Markdown verwenden:

## Willkommen auf meiner Webseite

Hier ist ein **fetter Text** und hier ist ein *kursiver Text*.

- Punkt 1
- Punkt 2
- Punkt 3

Weitere Informationen findest Du auf [unserer Webseite](https://www.example.com).

4. Erweiterte Markdown-Funktionen

Markdown kann durch verschiedene Erweiterungen und Plugins noch mächtiger gemacht werden. Kirby unterstützt auch erweiterte Markdown-Funktionen, die Du nutzen kannst, um Deine Inhalte noch besser zu strukturieren und zu präsentieren.

Codeblöcke

Für die Darstellung von Code kannst Du eingerückte Codeblöcke oder gekennzeichnete Codeblöcke verwenden:

```javascript
function helloWorld() {
    console.log("Hello, World!");
}

Horizontale Linien

Horizontale Linien können mit drei oder mehr Bindestrichen, Sternchen oder Unterstrichen erstellt werden:

---

5. KirbyText: Eine Erweiterung von Markdown in Kirby

Kirby bietet mit KirbyText eine Erweiterung von Markdown, die zusätzliche Tags und Funktionen bereitstellt. Mit KirbyText kannst Du spezielle Kirby-spezifische Tags verwenden, um Inhalte zu erweitern.

Beispiel für KirbyText:

(image: meinbild.jpg alt: Mein Bild caption: Dies ist ein Bild)

Hiermit kannst Du ein Bild mit einer Bildunterschrift einfügen. KirbyText wird automatisch erkannt und verarbeitet, wenn Du Markdown in Kirby verwendest.

Im Template kannst du via PHP den Text in echte HTML-Elemente umwandeln, indem du z.B. die folgende Funktion benutzt:

<?= page()->text()->kirbytext(); ?>

Fazit und Ausblick

Markdown ist ein unglaublich nützliches Werkzeug für die Pflege von Inhalten im Kirby CMS. Es bietet eine einfache Möglichkeit, Texte zu formatieren und strukturiert darzustellen, ohne dass dabei die Lesbarkeit des Rohtexts verloren geht. Durch die native Unterstützung von Markdown und die Erweiterungen durch KirbyText kannst Du Inhalte effizient und flexibel erstellen.

In neuen Kirby Versionen existiert neben der Möglichkeit Texte in Markdown zu strukturieren auch das s.g. Writer Field, welches die Benutzereingaben intern in HTML umwandelt und diese im Content speichert. Ob Markdown oder HTML: Das bleibt Geschacksache und ist auch abhängig von der Nutzung.

Viel Spaß beim Erstellen und Pflegen Deiner Inhalte mit Markdown und Kirby!