Siirry sisältöön

Johdanto

Näytä Markdown-muodossa Muokkaa palvelussa GitHub Dokumentaatio: 7b38e05

Onedocs sisältää asetteluja, komponentteja ja apureita dokumentaatiosivustoille, jotka on rakennettu kohteilla Next.js ja Fumadocs. Kirjoitat Markdown-tiedostoja, kuvaat sivustosi yhdessä asetustiedostossa, ja Onedocs tarjoaa dokumentaatiorungon, etusivun sekä SEO-reitit.

Se on tarkoitettu itsenäisille dokumentaatiosivustoille, ei dokumentaation lisäämiseen olemassa olevaan sovellukseen.

Mitä Onedocs sisältää

Fumadocs-pohjan päälle onedocs-paketti tarjoaa:

  • Asettelut – DocsLayout ja DocsPage ympäröivät kohteen Fumadocs UI-dokumentaatioasettelun, jossa on sivupalkki, haku, teeman vaihto ja sisällysluettelo. HomePage renderöi aloitussivun, jossa on pääosio, asennuskomennot, ominaisuudet ja alatunniste.
  • Yksi asetustiedosto – onedocs.config.ts sisältää otsikon, kuvauksen, logon, sivustokuvakkeen, navigointilinkit, alatunnisteen ja etusivun sisällön.
  • MDX-komponentit – mdxComponents rekisteröi ilmoituslaatikot, välilehdet, kortit, vaiheet, haitarit, tiedostopuut, kuvan suurennuksen ja tyyppitaulukot, joten sivut voivat käyttää niitä ilman tuonteja.
  • CSS-esiasetus – yksi tuonti tuo käyttöön kohteen Tailwind CSS v4, teeman Fumadocs UI ja asettelun Onedocs-tyylit.
  • SEO-apufunktiot – funktiot kohteille sitemap.xml, robots.txt, llms.txt, llms-full.txt, sivun metatiedoille ja Open Graph-kuville.

Mitä sinun on määritettävä itse

Onedocs ei sisällä kohteita Next.js eikä Fumadocs. Ne ovat vertaisriippuvuuksia, jotka asennat sen rinnalle:

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

Tarvitset myös kohteet Tailwind CSS v4 ja Node.js 20.9 tai uudemman sekä noin kymmenen pientä tiedostoa: kohteen Next.js ja Fumadocs MDX-asetustiedostot, sisällön lähteen, juuriasettelun, dokumentaatioasettelun ja dokumentaatiosivun reitin. Getting Started-opas näyttää ne kaikki.

Missä asetukset määritetään

Mitä Missä
Sivuston otsikko, logo, navigointi, alatunniste onedocs.config.ts, katso Configuration
Etusivun pääosio ja ominaisuudet homepage kohteessa onedocs.config.ts, jonka HomePage renderöi kohteessa src/app/page.tsx
Dokumentaatioasettelu ja sivut src/app/docs/layout.tsx ja src/app/docs/[[...slug]]/page.tsx, katso Getting Started
Sisältökansio ja sivupalkin järjestys source.config.ts ja content/docs/meta.json
MDX-komponentit mdxComponents, katso Components
Haku, sivustokartta, robots.txt, llms.txt Reittitiedostot kohteessa src/app/, katso SEO & Search
Metatiedot ja Open Graph-kuvat onedocs/metadata ja onedocs/og, katso API Reference

Toimintaperiaate

  • Markdown ensin – kirjoita .md- tai .mdx-tiedostoja ja saat dokumentaation
  • Yksi asetustiedosto – sivustonlaajuiset asetukset ovat kohteessa onedocs.config.ts
  • Joustovaraa – tarvitsetko lisää hallintaa? Käytä suoraan kohdetta Fumadocs

Aloita tästä