Preskoči na vsebino

Uvod

Prikaži kot Markdown Uredi na GitHub Dokumentacija za 7b38e05

Onedocs je nabor postavitev, komponent in pomožnih funkcij za spletna mesta z dokumentacijo, zgrajena z Next.js in Fumadocs. Pišete Markdown, svoje spletno mesto opišete v eni konfiguracijski datoteki, Onedocs pa zagotovi ogrodje za dokumentacijo, domačo stran in poti SEO.

Namenjen je samostojnim spletnim mestom z dokumentacijo, ne dodajanju dokumentacije obstoječi aplikaciji.

Kaj doda Onedocs

Poleg Fumadocs vam paket onedocs ponuja:

  • Postavitve - DocsLayout in DocsPage ovijata postavitev dokumentacije Fumadocs UI s stransko vrstico, iskanjem, preklopom teme in kazalom vsebine. HomePage izriše pristajalno stran z uvodnim pasom, ukazi za namestitev, funkcijami in nogo strani.
  • Ena konfiguracijska datoteka - onedocs.config.ts vsebuje naslov, opis, logotip, ikono, navigacijske povezave, nogo strani in vsebino domače strani.
  • Komponente MDX - mdxComponents registrira poudarke, zavihke, kartice, korake, harmonike, drevesa datotek, povečavo slik in tabele tipov, da jih strani lahko uporabljajo brez uvozov.
  • Prednastavitev CSS - en uvoz vključi Tailwind CSS v4, temo Fumadocs UI in sloge postavitve Onedocs.
  • Pomožne funkcije SEO - funkcije za sitemap.xml, robots.txt, llms.txt, llms-full.txt, metapodatke strani in slike Open Graph.

Kaj nastavite sami

Onedocs ne vključuje paketov Next.js ali Fumadocs. Gre za vrstni odvisnosti, ki ju namestite poleg njega:

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

Potrebujete tudi Tailwind CSS v4, Node.js 20.9 ali novejši in približno deset manjših datotek: Next.js ter konfiguracijo Fumadocs MDX, vir vsebine, korensko postavitev, postavitev dokumentacije in pot do strani z dokumentacijo. V razdelku Uvod je prikazana vsaka od njih.

Kje so nastavitve

Kaj Kje
Naslov spletnega mesta, logotip, navigacija, noga strani onedocs.config.ts, glejte Konfiguracija
Uvodni pas in funkcije domače strani homepage v onedocs.config.ts, izriše pa ju HomePage v src/app/page.tsx
Postavitev in strani dokumentacije src/app/docs/layout.tsx in src/app/docs/[[...slug]]/page.tsx, glejte Uvod
Mapa z vsebino in vrstni red stranske vrstice source.config.ts in content/docs/meta.json
Komponente MDX mdxComponents, glejte Komponente
Iskanje, zemljevid spletnega mesta, robots.txt, llms.txt Datoteke poti v src/app/, glejte SEO in iskanje
Metapodatki in slike Open Graph onedocs/metadata in onedocs/og, glejte APIreferenca

Filozofija

  • Najprej Markdown - Napišite datoteke .md ali .mdx in ustvarite dokumentacijo
  • Ena konfiguracijska datoteka - Nastavitve za celotno spletno mesto so v onedocs.config.ts
  • Možnosti za več nadzora - Potrebujete več nadzora? Uporabite neposredno Fumadocs

Začnite tukaj