DokumentationDocumentationMdxFrontmatter

Frontmatter

Lär dig hur du använder frontmatter i MDX-filer.

Frontmatter är en viktig del av en MDX-fil. Det används för att definiera information om filens innehåll, till exempel titel, beskrivning, författare, publiceringsdatum osv.

Metadatahuvudet definieras i början av filen, mellan --- (tre bindestreck) i början och slutet.

Format

Metadatahuvudet definieras i nyckel-värde-format, där nyckeln är metadatans namn och värdet är metadatans innehåll.

Exempel:

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

Beroende på dokumenttyp (dokumentation, blogginlägg osv.) kan olika metadata användas.

Metadata för dokumentation

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

Exempel:

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

Metadata för blogginlägg

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

Exempel:

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