DokumentációDocumentationMdxFrontmatter

Frontmatter

Ismerd meg a frontmatter használatát az MDX fájlokban.

A frontmatter az MDX fájl fontos része. Arra szolgál, hogy információkat határozzon meg a fájl tartalmáról, például címet, leírást, szerzőt, publikálási dátumot stb.

A metaadatfejléc a fájl elején van meghatározva, a kezdő és záró --- (három kötőjel) között.

Formátum

A metaadatfejléc kulcs-érték formátumban van megadva, ahol a kulcs a metaadat neve, az érték pedig a metaadat tartalma.

Példa:

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

A dokumentum típusától függően (dokumentáció, blogbejegyzés stb.) különböző metaadatok használhatók.

Dokumentációs metaadatok

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

Példa:

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

Blogbejegyzések metaadatai

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

Példa:

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