DokumentasiDocumentationMdxFrontmatter

Frontmatter

Pelajari cara menggunakan frontmatter dalam file MDX.

Frontmatter adalah bagian penting dari file MDX. Bagian ini digunakan untuk mendefinisikan informasi tentang isi file, seperti judul, deskripsi, penulis, tanggal publikasi, dan sebagainya.

Header metadata didefinisikan di awal file, di antara --- (tiga tanda hubung) pada awal dan akhir.

Format

Header metadata didefinisikan dalam format key-value, dengan key sebagai nama metadata dan value sebagai isi metadata.

Contoh:

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

Tergantung jenis dokumen (dokumentasi, posting blog, dan sebagainya), metadata yang digunakan dapat berbeda.

Metadata untuk dokumentasi

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

Contoh:

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

Metadata untuk posting blog

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

Contoh:

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