ДокументацияDocumentationMdxFrontmatter

Frontmatter

Узнайте, как использовать frontmatter в MDX-файлах.

Frontmatter — важная часть MDX-файла. Он используется для описания содержимого файла, например заголовка, описания, автора, даты публикации и т. д.

Заголовок метаданных задается в начале файла между --- (тремя дефисами) в начале и конце.

Формат

Заголовок метаданных задается в формате ключ-значение, где ключ — это имя метаданных, а значение — содержимое метаданных.

Пример:

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

В зависимости от типа документа (документация, публикация блога и т. д.) можно использовать разные метаданные.

Метаданные для документации

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

Пример:

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

Метаданные для публикаций блога

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

Пример:

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