مقدمة
Onedocs مجموعة من التخطيطات والمكونات والمساعدات لمواقع التوثيق المبنية باستخدام Next.js وFumadocs. تكتب Markdown، وتصف موقعك في ملف إعداد واحد، ويوفّر Onedocs هيكل التوثيق وصفحة رئيسية ومسارات SEO.
صُمّم لمواقع التوثيق المستقلة، وليس لإضافة التوثيق إلى تطبيق قائم.
ما الذي يضيفه Onedocs
إضافةً إلى Fumadocs، تمنحك حزمة onedocs ما يلي:
- التخطيطات - يحيط
DocsLayoutوDocsPageبتخطيط توثيق UI من Fumadocs، مع شريط جانبي وبحث ومبدّل للسمة وجدول محتويات. ويعرضHomePageصفحة هبوط تضم عنوانًا رئيسيًا وأوامر التثبيت والميزات والتذييل. - ملف إعداد واحد - يحتوي
onedocs.config.tsعلى العنوان والوصف والشعار والأيقونة المفضلة وروابط التنقل والتذييل ومحتوى الصفحة الرئيسية. - مكونات MDX - يسجّل
mdxComponentsمربعات التنبيه وعلامات التبويب والبطاقات والخطوات والأقسام القابلة للطي وأشجار الملفات وتكبير الصور وجداول الأنواع، لتستخدمها الصفحات دون استيراد. - إعداد مسبق لـCSS - يستورد واحد يجلب Tailwind CSS v4 وسمة UI في Fumadocs وأنماط تخطيط Onedocs.
- مساعدات SEO - دوال لـ
sitemap.xmlوrobots.txtوllms.txtوllms-llms-full.txtوبيانات الصفحة الوصفية وصور Open Graph.
ما تحتاج إلى إعداده بنفسك
لا يضمّن Onedocs Next.js أو Fumadocs. فهما اعتمادان نظيران تثبّتهما إلى جانبه:
سطر الأوامر
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom
تحتاج أيضًا إلى Tailwind CSS v4 وNode.js 20.9 أو أحدث ونحو عشرة ملفات صغيرة: إعداد Next.js وFumadocs MDX ومصدر المحتوى والتخطيط الجذري وتخطيط التوثيق ومسار صفحة التوثيق. يعرض دليل البدء كل ملف منها.
مواضع الإعداد
| العنصر | الموضع |
|---|---|
| عنوان الموقع والشعار والتنقل والتذييل | onedocs.config.ts، راجع الإعداد |
| العنوان الرئيسي والميزات في الصفحة الرئيسية | homepage في onedocs.config.ts، ويعرضه HomePage في src/app/page.tsx |
| تخطيط التوثيق وصفحاته | src/app/docs/layout.tsx وsrc/app/docs/[[...slug]]/page.tsx، راجع دليل البدء |
| مجلد المحتوى وترتيب الشريط الجانبي | source.config.ts وcontent/docs/meta.json |
| مكونات MDX | mdxComponents، راجع المكونات |
| البحث وخريطة الموقع وrobots.txt وllms.txt | ملفات المسارات ضمن src/app/، راجع SEO والبحث |
| البيانات الوصفية وصور Open Graph | onedocs/metadata وonedocs/og، راجع مرجع API |
الفلسفة
- Markdown أولًا - اكتب
.mdأو.mdxلتحصل على التوثيق - ملف إعداد واحد - توجد إعدادات الموقع العامة في
onedocs.config.ts - خيارات تحكم إضافية - لمزيد من التحكم، استخدم Fumadocs مباشرةً