Aller au contenu

Introduction

Afficher au format Markdown Modifier sur GitHub Documentation de 7b38e05

Onedocs est un ensemble de mises en page, de composants et de fonctions d’assistance pour les sites de documentation conçus avec Next.js et Fumadocs. Vous rédigez en Markdown, décrivez votre site dans un seul fichier de configuration et Onedocs fournit l’interface de documentation, une page d’accueil et les routes SEO.

Cet ensemble est destiné aux sites de documentation autonomes, et non à l’ajout de documentation à une application existante.

Ce que Onedocs apporte

En plus de Fumadocs, le paquet onedocs vous fournit :

  • Mises en page - DocsLayout et DocsPage enveloppent la mise en page de documentation Fumadocs UI, avec barre latérale, recherche, bascule de thème et table des matières. HomePage affiche une page d’accueil avec bannière, commandes d’installation, fonctionnalités et pied de page.
  • Un seul fichier de configuration - onedocs.config.ts contient le titre, la description, le logo, l’icône de favori, les liens de navigation, le pied de page et le contenu de la page d’accueil.
  • Composants MDX - mdxComponents enregistre des encadrés, onglets, cartes, étapes, accordéons, arborescences de fichiers, zoom d’image et tableaux de types, utilisables sans import dans les pages.
  • Préréglage CSS - un seul import fournit Tailwind CSS v4, le thème Fumadocs UI et les styles de mise en page Onedocs.
  • Fonctions d’assistance SEO - fonctions pour sitemap.xml, robots.txt, llms.txt, llms-full.txt, les métadonnées de page et les images Open Graph.

Ce que vous devez configurer vous-même

Onedocs n’intègre ni Next.js ni Fumadocs. Ce sont des dépendances homologues, à installer à ses côtés :

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

Vous avez également besoin de Tailwind CSS v4, de Node.js 20.9 ou version ultérieure et d’une dizaine de petits fichiers : la configuration Next.js et Fumadocs MDX, une source de contenu, la mise en page racine, la mise en page de documentation et la route des pages de documentation. Bien démarrer présente chacun d’eux.

Où configurer les éléments

Quoi Où
Titre du site, logo, navigation, pied de page onedocs.config.ts, voir Configuration
Bannière d’accueil et fonctionnalités homepage dans onedocs.config.ts, affichés par HomePage dans src/app/page.tsx
Mise en page et pages de documentation src/app/docs/layout.tsx et src/app/docs/[[...slug]]/page.tsx, voir Démarrage
Dossier de contenu et ordre de la barre latérale source.config.ts et content/docs/meta.json
Composants MDX mdxComponents, voir Composants
Recherche, plan du site, robots.txt, llms.txt Fichiers de routes sous src/app/, voir SEO et recherche
Métadonnées et images Open Graph onedocs/metadata et onedocs/og, voir la référence API

Philosophie

  • Markdown d’abord - Écrivez des fichiers .md ou .mdx, obtenez la documentation
  • Un fichier de configuration - Les paramètres du site sont définis dans onedocs.config.ts
  • Options de contrôle avancé - Besoin de plus de contrôle ? Utilisez directement Fumadocs

Pour commencer