DokumentacjaDocumentationMdxFrontmatter

Frontmatter

Dowiedz się, jak używać frontmatter w plikach MDX.

Frontmatter jest ważną częścią pliku MDX. Służy do definiowania informacji o zawartości pliku, takich jak tytuł, opis, autor, data publikacji itp.

Nagłówek metadanych jest definiowany na początku pliku, pomiędzy --- (trzema myślnikami) na początku i końcu.

Format

Nagłówek metadanych jest definiowany w formacie klucz-wartość, gdzie klucz jest nazwą metadanych, a wartość jest treścią metadanych.

Przykład:

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

W zależności od typu dokumentu (dokumentacja, wpis na blogu itp.) można używać różnych metadanych.

Metadane dla dokumentacji

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

Przykład:

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

Metadane dla wpisów na blogu

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

Przykład:

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