انتقل إلى المحتوى

التوثيق

السابق

كيف بُني هذا التوثيق وكيف تضيف صفحة.

يتبع التوثيق إعداد hogwarts نفسه، الذي يحاكي ui.shadcn.com/docs: محتوى MDX يترجمه fumadocs-mdx، وتلوين الكود وقت البناء بـ rehype-pretty-code، مع شريط جانبي وفهرس للصفحة وقائمة "نسخ الصفحة".

أضف صفحة

اكتب الصفحة الإنجليزية

أنشئ content/docs-en/<slug>.mdx مع title وdescription في الترويسة.

content/docs-en/example.mdx
---
title: Example
description: One sentence about the page.
---
 
## First section

اكتب الصفحة العربية

أنشئ content/docs-ar/<slug>.mdx بالمعرّف نفسه.

أضفها إلى الشريط الجانبي

أضف المعرّف إلى ملفي meta.json. العنصر "---Label---" يبدأ مجموعة معنونة.

أضفها إلى قائمة الهاتف

أضف الرابط إلى src/components/docs/docs-config.ts وعنوانه إلى docs.sidebar في القاموسين.

المكوّنات

المكوّنالاستخدام
<Callout>ملاحظة بارزة
<CardGrid> <DocCard>بطاقات مرتبطة
<Steps>خطوات مرقّمة من عناوين ###
<Tabs>محتوى بتبويبات
<Accordion>أقسام قابلة للطي

الملفات

الملفالدور
source.config.tsالمجموعات ومسار معالجة MDX
src/lib/source.tsمحمّل fumadocs لكل لغة
src/mdx-components.tsxتنسيق النصوص ومكوّنات التوثيق
src/app/[lang]/(site)/docs/مسارات التخطيط والصفحة
src/components/docs/الشريط الجانبي، والفهرس، ونسخ الصفحة، والتنبيهات