DokumentationDocumentationMdxFrontmatter

Frontmatter

Lernt, wie man Frontmatter in MDX-Dateien verwendet.

Das Frontmatter ist ein wichtiger Teil einer MDX-Datei. Es wird verwendet, um Informationen über den Inhalt der Datei zu definieren, wie Titel, Beschreibung, Autor, Veröffentlichungsdatum, etc.

Der Metadaten-Header ist am Anfang der Datei definiert, zwischen --- (drei Bindestriche) am Anfang und Ende.

Format

Der Metadaten-Header ist im Schlüssel-Wert-Format definiert, wobei der Schlüssel der Name der Metadaten und der Wert der Inhalt der Metadaten ist.

Beispiel:

---
title: Dokumenttitel
description: Dokumentbeschreibung
---

Je nach Art des Dokuments (Dokumentation, Blog-Post, etc.) können verschiedene Metadaten verwendet werden.

Metadaten für Dokumentation

  • title
  • description
  • links
    • source
    • docs
    • blog
    • api

Beispiel:

---
title: Dokumenttitel
description: Dokumentbeschreibung
links:
  source: https://google.com
  docs: /docs
  blog: /blog
  api: https://google.com
---

Metadaten für Blog-Posts

  • title
  • excerpt
  • date
  • author_id
  • og_image
  • tags
  • links
    • source
    • docs
    • blog
    • api

Beispiel:

---
title: Post-Titel
date: 2024-08-07 22:33:00
excerpt: Post-Auszug
author_id: daltonmenezes
og_image: introducing-blogs-og.jpg
links:
  source: https://google.com
  docs: /docs
  blog: /blog
  api: https://google.com
tags: [next.js, open-graph, blog]
---