Για τεκμηρίωση

1. Δημιουργήστε ένα νέο αρχείο .mdx στον φάκελο apps/content/docs/[language] με το περιεχόμενο του εγγράφου σας.
2. Προσθέστε το έγγραφο στο μενού πλοήγησης του site. Για να το κάνετε αυτό, προσθέστε ένα νέο item στο αρχείο src/config/docs.ts, στην ιδιότητα sidebarNav, με τις επιθυμητές πληροφορίες, ακολουθώντας απλώς το μοτίβο των υπαρχόντων items. Με αυτόν τον τρόπο, το έγγραφο θα προστεθεί επίσης στην παλέτα εντολών αναζήτησης.

Ρυθμίσεις εγγράφων MDX

Τα έγγραφα MDX αποθηκεύονται στους φακέλους apps/content/docs/[language] και apps/content/blog/[language]. Κάθε έγγραφο είναι ένα αρχείο MDX που περιέχει μια κεφαλίδα με metadata, όπως τίτλο και περιγραφή. Παρακάτω υπάρχει ένα παράδειγμα κεφαλίδας εγγράφου:

---
title: Document Title
description: Document Description.
sort: 1
---

Υποστηρίζονται τα παρακάτω πεδία metadata:

• title (απαιτείται): Ο τίτλος του εγγράφου.
• description (απαιτείται): Μια σύντομη περιγραφή του εγγράφου.
• sort (προαιρετικό): Ένας αριθμός που καθορίζει τη σειρά του εγγράφου στην πλοήγηση. Τα έγγραφα με χαμηλότερες τιμές sort εμφανίζονται πρώτα. Αν δεν δοθεί, τα έγγραφα ταξινομούνται αλφαβητικά με βάση τον τίτλο.
• links (προαιρετικό): Σύνδεσμοι προς σχετικά έγγραφα, API references, source code κ.λπ.
• toc (προαιρετικό): Αν θα εμφανίζεται ο πίνακας περιεχομένων. Η προεπιλογή είναι true.

Για να προσθέσετε νέα metadata στο έγγραφο, μπορείτε να προσθέσετε νέα keys στην κεφαλίδα. Για παράδειγμα, μπορείτε να προσθέσετε ένα key author για να δηλώσετε τον συγγραφέα του εγγράφου:

---
title: Document Title
description: Document Description.
sort: 2
author: Author Name
---

Όμως, όταν προσθέτετε custom metadata, πρέπει επίσης να ενημερώσετε το αρχείο contentlayer.config.ts που βρίσκεται στη ρίζα του project και μέσα στην ιδιότητα fields στις σταθερές Doc ή Blog. Μετά από αυτό, θα χρειαστεί να εμφανίσετε τη νέα πληροφορία στο template του εγγράφου. Για να το κάνετε αυτό, θα χρειαστεί να ενημερώσετε το αρχείο src/app/[locale]/docs/[[...slug]]/page.tsx, ή το src/app/[locale]/blog/[[...slug]]/page.tsx, ή ένα από τα child components του.

Αναδημιουργία του Contentlayer

Όταν κάνετε αλλαγές στο περιεχόμενο της τεκμηρίωσης, προσθέτετε νέα docs ή τροποποιείτε το αρχείο contentlayer.config.ts, θα χρειαστεί να αναδημιουργήσετε την cache του contentlayer ώστε οι αλλαγές σας να ισχύσουν κατά την ανάπτυξη. Εκτελέστε:

cd apps/web
pnpm contentlayer:build

Αυτή η εντολή αναδημιουργεί τους τύπους περιεχομένου και τα δεδομένα που χρειάζεται η εφαρμογή. Θα χρειαστεί να εκτελείτε αυτήν την εντολή κάθε φορά που:

• Προσθέτετε νέα πεδία metadata στο αρχείο contentlayer.config.ts
• Προσθέτετε ή τροποποιείτε περιεχόμενο MDX όταν ο dev server δεν εκτελείται
• Αλλάζετε τη δομή οργάνωσης του περιεχομένου σας

Η εντολή εκτελείται αυτόματα όταν γίνεται build του project για production, αλλά θα χρειαστεί να την εκτελείτε χειροκίνητα κατά την ανάπτυξη αν κάνετε δομικές αλλαγές στο περιεχόμενο.