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

Frontmatter

Дізнайтеся, як використовувати frontmatter у MDX файлах.

Frontmatter є важливою частиною MDX файлу. Він використовується для визначення інформації про вміст файлу, такої як назва, опис, автор, дата публікації тощо.

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

Формат

Заголовок метаданих задається у форматі key-value, де key — це назва метаданих, а value — вміст метаданих.

Приклад:

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