Next.js للتوثيق على Fumadocs
تخطيطات وصفحة رئيسية ومساعدات SEO لمواقع التوثيق المبنية باستخدام Next.js وFumadocs.
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562أحدث إصدار 0.1.27 MIT Next.js 16, Node 20.9+
import { HomePage, CTASection } from "onedocs";
export default function Home() {
return (
<HomePage config={config} packageName="my-package">
<CTASection
title="Ready to get started?"
cta={{ label: "Read the Docs", href: "/docs" }}
/>
</HomePage>
);
}في التطبيق العملي
يمرّر Onedocs كائن إعداد واحدًا إلى تخطيطات UI في Fumadocs.
إعداد واحد، وتخطيط واحد
يحتوي onedocs.config.ts على عنوان الموقع ووصفه ومستودع GitHub، ويقرأه DocsLayout مع شجرة الصفحات لمصدر Fumadocs لديك.
يعرض التخطيط الشريط الجانبي ومبدّل السمات ورابط GitHub مُنشأ من nav.github ومربع البحث الذي يستعلم عن مسار /api/search تضيفه.
يعرض دليل البدء الملفات الأخرى: مصدر المحتوى وإعداد Next.js والتخطيط الجذري ومسار الصفحة.
import { defineConfig } from "onedocs/config";
export default defineConfig({
title: "My Docs",
description: "Documentation for my project",
nav: {
github: "username/repo",
},
});import { DocsLayout } from "onedocs";
import type { ReactNode } from "react";
import { source } from "@/lib/source";
import config from "../../../onedocs.config";
export default function Layout({ children }: { children: ReactNode }) {
return (
<DocsLayout config={config} pageTree={source.pageTree}>
{children}
</DocsLayout>
);
}تخطيطات جاهزة
تمنحك DocsLayout وDocsPage وHomePage هيكلًا للتوثيق مع شريط جانبي وبحث وجدول محتويات، بالإضافة إلى صفحة هبوط.
ملف إعداد واحد
يضبط defineConfig() في onedocs.config.ts العنوان والوصف والشعار وروابط التنقل والتذييل والعنوان الرئيسي والميزات في الصفحة الرئيسية.
Markdown أولًا
اكتب ملفات .md أو .mdx في مجلد المحتوى، مع تمييز الصياغة وجدول محتويات في كل صفحة.
بحث
بحث Orama المضمّن في Fumadocs. أضف مسار API واحدًا باستخدام createFromSource وسيستخدمه مربع البحث.
الوضع الداكن
تأتي السمتان الفاتحة والداكنة من UI في Fumadocs، ويتضمن تخطيط التوثيق مبدّل السمات الخاص به. وتقبل الشعارات والأيقونات المفضلة نسخًا فاتحة وداكنة.
جاهز لـTypeScript
دعم TypeScript مع إعداد آمن للأنواع وإكمال تلقائي في المحرر.
SEO وllms.txt
مساعدات لـsitemap.xml وrobots.txt وllms.txt وllms-full.txt وبيانات الصفحة الوصفية وصور Open Graph.
قابل للتخصيص
مسارات تتيح لك استخدام مكونات Fumadocs عندما تحتاج إلى تحكم أكبر في توثيقك.
استكشف دليل Onedocs الكامل، من التثبيت والاستخدام الأول إلى مسارات العمل المتقدمة وتفاصيل API.