DokumentaceDocumentationMdxFrontmatter

Frontmatter

Naučte se používat frontmatter v souborech MDX.

Frontmatter je důležitou součástí souboru MDX. Používá se k definování informací o obsahu souboru, jako je název, popis, autor, datum publikace atd.

Hlavička metadat je definována na začátku souboru mezi --- (třemi spojovníky) na začátku a konci.

Formát

Hlavička metadat je definována ve formátu klíč-hodnota, kde klíč je název metadat a hodnota je obsah metadat.

Příklad:

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

V závislosti na typu dokumentu (dokumentace, blogový příspěvek atd.) lze použít různá metadata.

Metadata pro dokumentaci

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

Příklad:

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

Metadata pro blogové příspěvky

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

Příklad:

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