DocsDocumentationMdxFrontmatter

Frontmatter

Aprende a usar frontmatter en archivos MDX.

El frontmatter es una parte importante de un archivo MDX. Se usa para definir información sobre el contenido del archivo, como el título, la descripción, el autor, la fecha de publicación, etc.

El encabezado de metadatos se define al principio del archivo, entre --- (tres guiones) al inicio y al final.

Formato

El encabezado de metadatos se define en formato clave-valor, donde la clave es el nombre del metadato y el valor es el contenido del metadato.

Ejemplo:

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

Según el tipo de documento (documentación, publicación de blog, etc.), se pueden usar metadatos diferentes.

Metadatos para documentación

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

Ejemplo:

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

Metadatos para publicaciones de blog

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

Ejemplo:

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