ملفات المقال
1 دقيقة للقراءة
المقالات هي ملفات Markdown تحتوي على مقدمة YAML. يتم اشتقاق السبيكة الخاصة بالملف من اسم الملف بدون الامتداد .md.
المقدمة
المقدمة هي كتلة YAML في أعلى الملف، محاطة بـ ---. يتم تحليلها باستخدام مكتبة gray-matter.
الحقول
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
title | string | نعم | عنوان المقال (يجب ألا يكون فارغًا) |
description | string | لا | ملخص قصير للمقال |
meta_title | string | لا | عنوان مخصص لتحسين محركات البحث |
meta_description | string | لا | وصف مخصص لتحسين محركات البحث |
التحقق
يتم التحقق من المقدمة باستخدام مخطط Zod التالي:
typescript
z.object({
title: z.string().min(1),
description: z.string().optional(),
meta_title: z.string().optional(),
meta_description: z.string().optional(),
});
مثال
ملف باسم getting-started.md:
markdown
---
title: Getting Started
description: Learn how to set up your help center
meta_title: Getting Started | Help Center
meta_description: Step-by-step guide to setting up your help center
---
# Getting Started
Welcome to the help center. Follow these steps to get up and running.
## Prerequisites
- An active account
- API key from the dashboard
## Setup
1. Install the CLI
2. Run `opencx sync` to push your content
هذا ينتج مقالة مع السبيكة getting-started.