DocumentazioneDocumentationMdxFrontmatter

Frontmatter

Scopri come usare il frontmatter nei file MDX.

Il frontmatter è una parte importante di un file MDX. Viene usato per definire informazioni sul contenuto del file, come titolo, descrizione, autore, data di pubblicazione, ecc.

L'intestazione dei metadati viene definita all'inizio del file, tra --- (tre trattini) all'inizio e alla fine.

Formato

L'intestazione dei metadati è definita in formato chiave-valore, dove la chiave è il nome del metadato e il valore è il contenuto del metadato.

Esempio:

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

A seconda del tipo di documento (documentazione, post del blog, ecc.), possono essere usati metadati diversi.

Metadati per la documentazione

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

Esempio:

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

Metadati per i post del blog

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

Esempio:

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