Artikelbestanden
1 min leestijd
Artikelen zijn Markdown-bestanden met YAML frontmatter. De slug van het bestand is afgeleid van de bestandsnaam minus de .md extensie.
Frontmatter
Frontmatter is een YAML-blok aan de bovenkant van het bestand, begrensd door ---. Het wordt geparsed met behulp van de gray-matter bibliotheek.
Velden
| Veld | Type | Vereist | Beschrijving |
|---|---|---|---|
title | string | Ja | De titel van het artikel (mag niet leeg zijn) |
description | string | Nee | Een korte samenvatting van het artikel |
meta_title | string | Nee | Aangepaste titel voor SEO |
meta_description | string | Nee | Aangepaste beschrijving voor SEO |
Validatie
De frontmatter wordt gevalideerd met het volgende Zod-schema:
typescript
z.object({
title: z.string().min(1),
description: z.string().optional(),
meta_title: z.string().optional(),
meta_description: z.string().optional(),
});
Voorbeeld
Een bestand genaamd getting-started.md:
markdown
---
title: Aan de slag
description: Leer hoe je je helpcentrum kunt opzetten
meta_title: Aan de slag | Helpcentrum
meta_description: Stapsgewijze handleiding voor het opzetten van je helpcentrum
---
# Aan de slag
Welkom bij het helpcentrum. Volg deze stappen om aan de slag te gaan.
## Vereisten
- Een actief account
- API-sleutel van het dashboard
## Installatie
1. Installeer de CLI
2. Voer `opencx sync` uit om je inhoud te pushen
Dit produceert een artikel met de slug getting-started.