DocsDocumentationMdxFrontmatter

Frontmatter

Leer hoe je frontmatter gebruikt in MDX-bestanden.

De frontmatter is een belangrijk onderdeel van een MDX-bestand. Deze wordt gebruikt om informatie over de inhoud van het bestand te definieren, zoals titel, beschrijving, auteur, publicatiedatum, enz.

De metadataheader wordt aan het begin van het bestand gedefinieerd, tussen --- (drie koppeltekens) aan het begin en einde.

Formaat

De metadataheader wordt gedefinieerd in key-value-formaat, waarbij de key de naam van de metadata is en de value de inhoud van de metadata.

Voorbeeld:

---
title: Document title
description: Document description
---

Afhankelijk van het type document (documentatie, blogpost, enz.) kan andere metadata worden gebruikt.

Metadata voor documentatie

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

Voorbeeld:

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

Metadata voor blogposts

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

Voorbeeld:

---
title: Post title
date: 2024-08-07 22:33:00
excerpt: Post excerpt
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]
---