Skip to content

Frontmatter Standard

In this project we maintain a strict standard for frontmatter (the section between --- at the top of a Markdown file). This ensures that our documentation is consistent, easily searchable and neatly organised.

Every .md or .mdx file MUST contain the following fields:

The title of the page. This is displayed in the browser tab, search results and at the top of the page itself.

Rules:

  • Short and concise.
  • No markdown formatting.

A short summary of the page content.

Rules:

  • Required! The site will give an error message if you forget this.
  • 1 to 2 sentences.
  • Used for SEO and in search results.
---
title: My Page Title
description: A brief explanation of what this page is about. This is required.
---
The rest of your content...

You may also use other Starlight frontmatter fields, such as:

  • sidebar: To adjust the order or label in the menu.
  • tableOfContents: To turn the table of contents on or off.

Note: If you forget description, the build will fail with the message: A description is required!

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.