DocsDocumentationMdxFrontmatter

Frontmatter

Lær, hvordan du bruger frontmatter i MDX-filer.

Frontmatter er en vigtig del af en MDX-fil. Det bruges til at definere oplysninger om filens indhold, såsom titel, beskrivelse, forfatter, udgivelsesdato osv.

Metadataheaderen defineres i begyndelsen af filen mellem --- (tre bindestreger) i starten og slutningen.

Format

Metadataheaderen defineres i key-value-format, hvor nøglen er metadataens navn, og værdien er metadataens indhold.

Eksempel:

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

Afhængigt af dokumenttypen (dokumentation, blogindlæg osv.) kan forskellige metadata bruges.

Metadata til dokumentation

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

Eksempel:

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

Metadata til blogindlæg

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

Eksempel:

---
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]
---