ドキュメントDocumentationMdxFrontmatter

Frontmatter

MDX ファイルで frontmatter を使う方法を学びます。

frontmatter は MDX ファイルの重要な部分です。 タイトル、説明、著者、公開日など、ファイルの内容に関する情報を定義するために使います。

メタデータヘッダーはファイルの先頭に定義し、開始と終了を ---（3つのハイフン）で囲みます。

形式

メタデータヘッダーはキーと値の形式で定義します。キーはメタデータ名、値はメタデータの内容です。

例:

---
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]
---
ComponentsUsing mscp for Fast File Transfers