Frontmatter-Standard
In diesem Projekt halten wir einen strengen Standard für das Frontmatter (den Bereich zwischen --- am Anfang einer Markdown-Datei) ein. Dies stellt sicher, dass unsere Dokumentation konsistent, gut auffindbar und ordentlich organisiert ist.
Pflichtfelder
Abschnitt betitelt „Pflichtfelder“Jede .md- oder .mdx-Datei MUSS die folgenden Felder enthalten:
Der Titel der Seite. Dieser wird im Browser-Tab, in den Suchergebnissen und oben auf der Seite selbst angezeigt.
Regeln:
- Kurz und prägnant.
- Keine Markdown-Formatierung.
description
Abschnitt betitelt „description“Eine kurze Zusammenfassung des Seiteninhalts.
Regeln:
- Pflichtfeld! Die Website gibt eine Fehlermeldung aus, wenn Sie dies vergessen.
- 1 bis 2 Sätze.
- Wird für SEO und in Suchergebnissen verwendet.
Beispiel
Abschnitt betitelt „Beispiel“---title: Mein Seitentiteldescription: Eine kurze Erklärung, worum es auf dieser Seite geht. Dies ist Pflicht.---
Der Rest Ihres Inhalts...Optionale Felder
Abschnitt betitelt „Optionale Felder“Sie können auch andere Starlight-Frontmatter-Felder verwenden, wie:
sidebar: Um die Reihenfolge oder das Label im Menü anzupassen.tableOfContents: Um das Inhaltsverzeichnis ein- oder auszuschalten.
Hinweis: Wenn Sie description vergessen, schlägt der Build fehl mit der Meldung: Eine Beschreibung ist erforderlich!
Medische Disclaimer: De informatie van Stichting Je Leefstijl Als Medicijn over leefstijl, ziektes en stoornissen mag niet worden opgevat als medisch advies. In geen geval adviseren wij mensen om hun bestaande behandeling te veranderen. We raden mensen met chronische aandoeningen aan om zich over hun behandeling goed door bevoegde medische professionals te laten adviseren.
Medical Disclaimer: The information provided by Stichting Je Leefstijl Als Medicijn regarding lifestyle, diseases, and disorders should not be construed as medical advice. Under no circumstances do we advise people to alter their existing treatment. We recommend that people with chronic conditions seek advice regarding their treatment from qualified medical professionals.