Μετάβαση στο περιεχόμενο

Εισαγωγή

Προβολή ως Markdown Επεξεργασία στο GitHub Τεκμηρίωση στο 7b38e05

Το Onedocs είναι ένα σύνολο διατάξεων, στοιχείων και βοηθητικών συναρτήσεων για ιστότοπους τεκμηρίωσης που έχουν δημιουργηθεί με Next.js και Fumadocs. Γράφετε Markdown, περιγράφετε τον ιστότοπό σας σε ένα αρχείο config και το Onedocs παρέχει το βασικό κέλυφος τεκμηρίωσης, μια αρχική σελίδα και τις διαδρομές SEO.

Προορίζεται για αυτόνομους ιστότοπους τεκμηρίωσης, όχι για την προσθήκη τεκμηρίωσης σε υπάρχουσα εφαρμογή.

Τι προσθέτει το Onedocs

Επιπλέον του Fumadocs, το πακέτο onedocs παρέχει:

  • Διατάξεις - Τα DocsLayout και DocsPage περιβάλλουν τη διάταξη τεκμηρίωσης Fumadocs UI, με πλευρική γραμμή, αναζήτηση, εναλλαγή θέματος και πίνακα περιεχομένων. Το HomePage αποδίδει σελίδα προορισμού με hero, εντολές εγκατάστασης, χαρακτηριστικά και υποσέλιδο.
  • Ένα αρχείο config - Το onedocs.config.ts περιέχει τον τίτλο, την περιγραφή, το λογότυπο, το favicon, τους συνδέσμους πλοήγησης, το υποσέλιδο και το περιεχόμενο της αρχικής σελίδας.
  • Στοιχεία MDX - Το mdxComponents καταχωρίζει πλαίσια επισήμανσης, καρτέλες, κάρτες, βήματα, αναδιπλούμενες ενότητες, δέντρα αρχείων, μεγέθυνση εικόνων και πίνακες τύπων, ώστε οι σελίδες να τα χρησιμοποιούν χωρίς εισαγωγές.
  • Προκαθορισμένη ρύθμιση CSS - Μία εισαγωγή προσθέτει το Tailwind CSS v4, το θέμα Fumadocs UI και τα στυλ διάταξης Onedocs.
  • Βοηθητικές συναρτήσεις SEO - Συναρτήσεις για sitemap.xml, robots.txt, llms.txt, llms-full.txt, μεταδεδομένα σελίδων και εικόνες Open Graph.

Τι ρυθμίζετε μόνοι σας

Το Onedocs δεν περιλαμβάνει τα Next.js ή Fumadocs. Είναι εξαρτήσεις peer που εγκαθιστάτε δίπλα του:

Κέλυφος
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom

Χρειάζεστε επίσης Tailwind CSS v4, Node.js 20.9 ή νεότερο και περίπου δέκα μικρά αρχεία: το config Next.js και Fumadocs MDX, μια πηγή περιεχομένου, τη διάταξη ρίζας, τη διάταξη τεκμηρίωσης και τη διαδρομή σελίδων τεκμηρίωσης. Η ενότητα Ξεκινώντας παρουσιάζει καθένα από αυτά.

Πού διαμορφώνονται τα στοιχεία

Τι Πού
Τίτλος ιστοτόπου, λογότυπο, πλοήγηση, υποσέλιδο onedocs.config.ts, δείτε την ενότητα Διαμόρφωση
Hero και χαρακτηριστικά αρχικής σελίδας 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 και λάβετε τεκμηρίωση
  • Ένα αρχείο config - Οι ρυθμίσεις ολόκληρου του ιστοτόπου βρίσκονται στο onedocs.config.ts
  • Δυνατότητες προσαρμογής - Χρειάζεστε περισσότερο έλεγχο; Χρησιμοποιήστε απευθείας το Fumadocs

Ξεκινήστε εδώ