الوثائق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]
---