DokümanlarDocumentationMdxFrontmatter

Frontmatter

MDX dosyalarında frontmatter kullanmayı öğrenin.

Frontmatter, bir MDX dosyasının önemli bir parçasıdır. Dosyanın içeriğiyle ilgili başlık, açıklama, yazar, yayın tarihi vb. bilgileri tanımlamak için kullanılır.

Metadata başlığı, dosyanın başında, başlangıç ve bitişte --- (üç tire) arasında tanımlanır.

Format

Metadata başlığı, anahtarın metadata adı ve değerin metadata içeriği olduğu key-value biçiminde tanımlanır.

Örnek:

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

Belge türüne (dokümantasyon, blog yazısı vb.) bağlı olarak farklı metadata kullanılabilir.

Dokümantasyon için metadata

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

Örnek:

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

Blog yazıları için metadata

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

Örnek:

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