# Aloitus

Tässä oppaassa perustetaan dokumentaatiosivusto kohteella Onedocs tyhjään kansioon. Jos sinulla on jo Next.js-projekti, ohita valmiina olevat tiedostot ja vertaa muita.

## Edellytykset

- Node.js 20.9 tai uudempi (Next.js 16 edellyttää tätä)
- Next.js 16 App Routerilla, React 19.2 tai uudempi
- Tailwind CSS v4 (Onedocs CSS-esiasetus tuo käyttöön kohteen `tailwindcss`)

Fumadocs UI 16 tukee vain versioita Next.js 16 ja React 19.2. Siksi vanhemmat Next.js- tai React-versiot eivät toimi, vaikka paketin `onedocs`-metatiedoissa ne yhä mainitaan ([#5](https://github.com/inline0/onedocs/issues/5)).

## Asennus

Onedocs ei sisällä kohteita Next.js eikä Fumadocs. Ne ovat vertaisriippuvuuksia, joten asenna ne sen rinnalle:

```bash
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom
npm install -D tailwindcss @tailwindcss/postcss typescript @types/react @types/react-dom @types/node
```

Säilytä `lucide-react@0.562`-kiinnitys. `onedocs` 0.1.27 määrittää kohteen `lucide-react` `^0.562.0` vertaisriippuvuudeksi. Ilman kiinnitystä npm asentaa lucide-reactin kohteeseen 1.x ja pysähtyy `ERESOLVE`-virheeseen ([#1](https://github.com/inline0/onedocs/issues/1)).

Samat paketit toimivat myös pnpm:n, yarnin ja bunin kanssa.

Lisää komentosarjat Next.js tiedostoon `package.json`:

```json title="package.json"
{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start"
  }
}
```

## Projektin rakenne

Lopputulos näyttää tältä:

```
your-project/
├── content/
│   └── docs/
│       ├── index.mdx
│       └── meta.json
├── public/
│   └── fonts/
│       └── InterVariable.woff2
├── src/
│   ├── app/
│   │   ├── layout.tsx
│   │   ├── page.tsx
│   │   ├── globals.css
│   │   └── docs/
│   │       ├── layout.tsx
│   │       └── [[...slug]]/
│   │           └── page.tsx
│   └── lib/
│       └── source.ts
├── onedocs.config.ts
├── source.config.ts
├── next.config.mjs
├── postcss.config.mjs
├── tsconfig.json
└── package.json
```

Luodaan jokainen tiedosto.

## Asetustiedostot

### onedocs.config.ts

Pääasiallinen asetustiedosto. Vain `title` on pakollinen. Katso muut asetukset [Configuration](https://onedocs.inline0.dev/fi/docs/configuration)-sivulta.

```ts title="onedocs.config.ts"
import { defineConfig } from "onedocs/config";

export default defineConfig({
  title: "My Docs",
  description: "Documentation for my project",
  nav: {
    github: "username/repo",
  },
});
```

### source.config.ts

Kertoo kohteelle Fumadocs MDX, missä sisältö sijaitsee. Sisältökansion sijainti asetetaan vain täällä:

```ts title="source.config.ts"
import { defineDocs } from "fumadocs-mdx/config";

export const docs = defineDocs({
  dir: "content/docs",
});
```

### next.config.mjs

Ottaa käyttöön MDX-käsittelyn:

```js title="next.config.mjs"
import { createMDX } from "fumadocs-mdx/next";

const withMDX = createMDX();

/** @type {import('next').NextConfig} */
const config = {};

export default withMDX(config);
```

Fumadocs MDX luo `.source/`-kansion kohteesta `source.config.ts`, kun Next.js käynnistyy. Lisää `.source` kohteeseen `.gitignore`.

### postcss.config.mjs

Suorittaa kohteen Tailwind CSS v4, jonka pohjalle Onedocs CSS-esiasetus on rakennettu:

```js title="postcss.config.mjs"
export default {
  plugins: {
    "@tailwindcss/postcss": {},
  },
};
```

### tsconfig.json

Alla olevissa esimerkeissä tuodaan sisältö kohteesta `@/`, joten määritä sille alias `src/`:

```json title="tsconfig.json"
{
  "compilerOptions": {
    "paths": {
      "@/*": ["./src/*"]
    }
  }
}
```

Next.js lisää tähän tiedostoon tarvitsemansa kääntäjäasetukset, kun suoritat ensimmäisen kerran `next dev`- tai `next build`-komennon.

## Lähteen määritys

### src/lib/source.ts

Lataa dokumentaatiosisältösi:

```ts title="src/lib/source.ts"
import { loader } from "fumadocs-core/source";
import { docs } from "../../.source/server";

export const source = loader({
  baseUrl: "/docs",
  source: docs.toFumadocsSource(),
});
```

## Sovellustiedostot

### src/app/layout.tsx

Juuriasettelu:

```tsx title="src/app/layout.tsx"
import type { Metadata } from "next";
import { RootProvider } from "fumadocs-ui/provider/next";
import { FontHead } from "onedocs";
import "./globals.css";

export const metadata: Metadata = {
  title: "My Docs",
  description: "Documentation for my project",
};

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en" suppressHydrationWarning>
      <head>
        <FontHead />
      </head>
      <body className="antialiased">
        <RootProvider>{children}</RootProvider>
      </body>
    </html>
  );
}
```

`RootProvider` kohteesta Fumadocs UI tarjoaa hakudialogin sekä vaalean ja tumman teeman. `FontHead` lataa Inter Variable -fontin ennakkoon kohteesta `/fonts/InterVariable.woff2` ja asettaa sen sivun fontiksi. Onedocs ei sisällä fonttitiedostoa: lataa `InterVariable.woff2` [Inter-julkaisuista](https://github.com/rsms/inter/releases) ja sijoita se kohteeseen `public/fonts/`. Ilman sitä tekstissä käytetään järjestelmän sans-serif-fonttia.

Jos haluat luoda nämä metatiedot asetustiedostostasi, katso [API Reference](https://onedocs.inline0.dev/fi/docs/api-reference#createmetadata) -sivun kohtaa `createMetadata`.

### src/app/globals.css

Tuo CSS-esiasetus:

```css title="src/app/globals.css"
@import "onedocs/css/preset.css";

@source "./**/*.tsx";
@source "../../content/**/*.mdx";
```

Esiasetus lataa kohteen Tailwind CSS, Fumadocs UI-tyylit ja kohteen Onedocs asettelutyylit. Polut `@source`-tiedostossa ovat suhteessa kohteeseen `globals.css`, joten nämä kaksi riviä osoittavat kohteeseen `src/app/` ja projektin juurihakemiston `content/`-kansioon.

### src/app/page.tsx

Etusivu. `HomePage` renderöi pääosion, ominaisuudet ja alatunnisteen asetustiedostosi perusteella:

```tsx title="src/app/page.tsx"
import { HomePage } from "onedocs";
import config from "../../onedocs.config";

export default function Home() {
  return <HomePage config={config} packageName="my-package" />;
}
```

`packageName` lisää etusivun pääosioon kohteiden npm, yarn, pnpm ja bun asennuskomennot. Jätä se pois, jos projektisi ei ole paketti.

### src/app/docs/layout.tsx

Dokumentaatioasettelu sivupalkilla:

```tsx title="src/app/docs/layout.tsx"
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>
  );
}
```

### src/app/docs/[[...slug]]/page.tsx

Yksittäiset dokumentaatiosivut:

```tsx title="src/app/docs/[[...slug]]/page.tsx"
import { source } from "@/lib/source";
import { DocsPage, mdxComponents } from "onedocs";
import { notFound } from "next/navigation";

export default async function Page(props: {
  params: Promise<{ slug?: string[] }>;
}) {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();

  const MDX = page.data.body;

  return (
    <DocsPage toc={page.data.toc}>
      <MDX components={mdxComponents} />
    </DocsPage>
  );
}

export async function generateStaticParams() {
  return source.generateParams();
}

export async function generateMetadata(props: {
  params: Promise<{ slug?: string[] }>;
}) {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();

  return {
    title: page.data.title,
    description: page.data.description,
  };
}
```

## Sisältö

### content/docs/index.mdx

Jokaisen sivun etumäärittelyssä on oltava `title`. `description` on valinnainen:

```mdx title="content/docs/index.mdx"
---
title: Introduction
description: What this project does.
---

Welcome to the docs. Components such as `<Callout>` work without imports; see [Components](/docs/components).
```

### content/docs/meta.json

Määrittää sivupalkin järjestyksen:

```json title="content/docs/meta.json"
{
  "pages": ["index"]
}
```

Lisää sivu luomalla toinen `.mdx`-tiedosto ja lisäämällä sen nimi kohteeseen `pages`.

## Käynnistä

Käynnistä kehityspalvelin:

```bash
npm run dev
```

Etusivu on osoitteessa `http://localhost:3000` ja dokumentaatio osoitteessa `http://localhost:3000/docs`.

Luo tuotantoversio:

```bash
npm run build
```

Lisää seuraavaksi haku, sivustokartta ja llms.txt sivulla [SEO & Search](https://onedocs.inline0.dev/fi/docs/seo-search).