DocumentațieDocumentationMdxFrontmatter

Frontmatter

Învață cum să folosești frontmatter în fișierele MDX.

Frontmatter este o parte importantă a unui fișier MDX. Este folosit pentru a defini informații despre conținutul fișierului, cum ar fi titlul, descrierea, autorul, data publicării etc.

Antetul cu metadate este definit la începutul fișierului, între --- (trei cratime) la început și la sfârșit.

Format

Antetul cu metadate este definit în format cheie-valoare, unde cheia este numele metadatei, iar valoarea este conținutul metadatei.

Exemplu:

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

În funcție de tipul documentului (documentație, articol de blog etc.), pot fi folosite metadate diferite.

Metadate pentru documentație

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

Exemplu:

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

Metadate pentru articole de blog

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

Exemplu:

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