DocsDocumentationMdxFrontmatter

Frontmatter

Μάθετε πώς να χρησιμοποιείτε frontmatter σε αρχεία MDX.

Το frontmatter είναι σημαντικό μέρος ενός αρχείου MDX. Χρησιμοποιείται για να ορίσει πληροφορίες σχετικά με το περιεχόμενο του αρχείου, όπως τίτλο, περιγραφή, συγγραφέα, ημερομηνία δημοσίευσης κ.λπ.

Η κεφαλίδα metadata ορίζεται στην αρχή του αρχείου, ανάμεσα σε --- (τρεις παύλες) στην αρχή και στο τέλος.

Μορφή

Η κεφαλίδα metadata ορίζεται σε μορφή key-value, όπου το key είναι το όνομα του metadata και η value είναι το περιεχόμενο του metadata.

Παράδειγμα:

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

Ανάλογα με τον τύπο του εγγράφου (τεκμηρίωση, blog post κ.λπ.), μπορούν να χρησιμοποιηθούν διαφορετικά metadata.

Metadata για τεκμηρίωση

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

Metadata για blog posts

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