Doku bearbeiten

1. Zugriff auf die Dokumentation

2. Anmelden im Backend

  • Melde dich mit deinen Zugangsdaten im Backend an.

  • Nach erfolgreicher Anmeldung gelangst du zur Übersicht des GravCMS-Systems. (Hinweis: GravCMS wird als CMS genutzt, der Umgang mit GravCMS ist jedoch für den Endanwender nicht entscheidend.)

3. Seiten hinzufügen und Unterseiten anlegen

  • Neuen Seiten-Eintrag erstellen:

    Im Backend findest du den Button “Add Page” im Menüpunkt “Pages” zum Erstellen einer neuen Seite.

  • Seitentitel und URL:

    Gib einen aussagekräftigen Titel an. Daraus ergibt sich auch der Pfad in der URL. Im Reiter Advanced kannst du den Pfad anpassen, indem du diesen im Feld “Slug” überschreibst.

  • Inhalt bearbeiten:

    Bearbeite den Inhalt der Seite mit dem integrierten Markdown-Editor. Weitere Infos zum Markdown Editor und dessen Formatierung findest du weiter unten.

    Unterseiten anlegen:

  • Hierarchie beachten:

    Um eine Unterseite zu erstellen, wähle als übergeordnete Seite (Parent Page) die entsprechende Hauptseite aus.

4. Verwendung des Templates

  • Standard-Template ("Default") :

    Für neue Seiten wird üblicherweise das Template „Default“ verwendet. Achte darauf, dass bei der Erstellung oder Bearbeitung einer Seite dieses Template ausgewählt ist. Diese Option findest du unter dem Reiter “Advanced”

5. Upload und Einbindung von Medien

Bild und Video hochladen:

  • Upload-Funktion:

    Im Backend gibt es eine Upload-Funktion, über die du Bilder und Videos hochladen kannst.

  • Upload-Limit:

    Beachte, dass das Upload-Limit bei 2GB pro Upload liegt.

Einbindung in die Inhalte:

  • Bilder:

    Nachdem das Bild hochgeladen wurde, kannst du es über die Markdown-Syntax einbinden, beispielsweise: Alternativtext

  • Videos:

    Bei Videos verhält es sich ähnlich. Man kann außerdem parameter wie Klassen ergänzen indem man diese wie folgt ergänzt [ Video 1

Weitere Parameter findet ihr hier: https://learn.getgrav.org/17/content/media

6. Markdown Formatierung

  • Grundlagen:

    Die Dokumentation verwendet Markdown für die Textformatierung. Dabei können Überschriften, Listen, Links, Bilder und andere Elemente einfach per Text eingegeben werden.

  • Überschrift:
        Überschrift 1 ## Überschrift 2
  • Fett und Kursiv:
          **fett** oder *kursiv*

    7. Cache löschen

    • Notwendigkeit:

      Nach Änderungen an der Dokumentation kann es notwendig sein, den Cache zu leeren, um die aktuellste Version anzuzeigen. Klickt dafür nach Bearbeitung auf den “Cache leeren”-Button oben links unter eurem Profil: how-to-28