Überblick über das erstellte Projekt

In deinem Projekt findest du verschiedene Ordner und Dateien. Die Struktur deines Projekts sollte dabei ungefähr so aussehen:

mein-easywebsite-projekt:
  dokument:
    - assets:
      - beispielbild.jpg
      - logo.svg
      - logo-w.svg
    - 1_Ordner:
      - _meta.yaml
      - index.mdx
      - 1_1_Erste_Seite.md
    - _meta.yaml
    - index.mdx
    - abkuerzungen.yaml
    - barriere-melden.md
    - datenschutz.md
    - erklaerung-zur-barrierefreiheit.md
    - glossar.yaml
    - impressum.md
    - leichte-sprache.md
  LICENSE
  LICENSE.spdx
  README.md

In dem Ordner dokument findest du alle Dateien und Unterordner, die deine Webseite ausmachen. Darin befinden sich unter anderem:

1. Verschiedene Markdown- oder MDX-Dateien (.md oder .mdx)
   • Beinhalten die Inhalte deiner Webseite.
   • Dateien, die index.mdx heißen, werden als die Startseite des jeweiligen Ordners verwendet in denen sie liegen
     Hinweis

     Wenn du deinen Unterordnern jeweils eine eigene Startseite geben möchtest, dann musst du diese trotzdem in der _meta.yaml Datei des jeweiligen Ordners als 'index' definieren.

2. Verschiedene YAML-Dateien
   • _meta.yaml-Dateien
     • In diesen Dateien kannst du die Metadaten zu einem jeweiligen Ordner und dessen Unterseiten hinterlegen
     • Weiterhin bestimmst du hier, wie genau deine Seiten in der Seitenleiste der Webseite dargestellt werden (z.B. unter welcher Überschrift eine Seite angezeigt wird).
   • abkuerzungen.yaml oder glossar.yaml
     • In diesen Dateien kannst du Abkürzungen und Glossar-Einträge hinterlegen, die dann automatisch auf deiner Webseite angezeigt werden.
     • Entsprechende Begriffe werden in deinen Texten hervorgehoben und deine Definitionen tauchen dann in einem Popup auf, wenn du mit der Maus über den Begriff fährst.
       Hinweis

       Hier findest du eine Anleitung zur Syntax von YAML-Dateien.

       Zur YAML-Syntax Anleitung (extern)
3. Der Ordner assets
   • Hier kannst du Bilder und andere Medien ablegen, die du in deinen Markdown-Seiten verwenden möchtest.