Next.js τεκμηρίωση για Fumadocs

Διατάξεις, αρχική σελίδα και βοηθητικές συναρτήσεις SEO για ιστοτόπους τεκμηρίωσης που έχουν δημιουργηθεί με Next.js και Fumadocs.

Τερματικό

npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562

Ξεκινήστε

GitHub

Τελευταία έκδοση 0.1.27 2026-03-26 MIT Next.js 16, Node 20.9+

TSX

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 που προσθέτετε.

Ο οδηγός Getting Started παρουσιάζει τα υπόλοιπα αρχεία: την πηγή περιεχομένου, τη διαμόρφωση 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 και ο διάλογος αναζήτησης θα τη χρησιμοποιεί.

Σκούρα λειτουργία

Τα ανοιχτά και σκούρα θέματα προέρχονται από το Fumadocs UI, ενώ η διάταξη τεκμηρίωσης περιλαμβάνει τον διακόπτη θεμάτων του. Τα λογότυπα και τα favicon δέχονται ανοιχτές και σκούρες παραλλαγές.

Έτοιμο για TypeScript

Υποστήριξη TypeScript με ασφαλή ως προς τους τύπους διαμόρφωση και αυτόματη συμπλήρωση στον επεξεργαστή σας.

SEO και llms.txt

Βοηθητικές συναρτήσεις για sitemap.xml, robots.txt, llms.txt, llms-full.txt, μεταδεδομένα σελίδων και εικόνες Open Graph.

Προσαρμόσιμο

Δυνατότητες προσαρμογής μέσω των στοιχείων Fumadocs όταν χρειάζεστε περισσότερο έλεγχο στην τεκμηρίωσή σας.

Εξερευνήστε τον πλήρη οδηγό του Onedocs, από την εγκατάσταση και την πρώτη χρήση έως τις προηγμένες ροές εργασίας και τις λεπτομέρειες του API.

Διαβάστε την τεκμηρίωση

Προβολή πηγαίου κώδικα