Tiramisu Docs

Getting Started

Installation

Installieren Sie Tiramisu Docs per Scaffolder oder richten Sie ein Projekt manuell mit SvelteKit ein.

Scaffolder

Der schnellste Weg loszulegen ist mit dem Scaffolder:

bun create tiramisu-docs my-docs

Der Scaffolder fragt Sie nach Sektionen und i18n. Danach:

cd my-docs
bun install
bun run dev

Manuelle Einrichtung

Wenn Sie die Einrichtung lieber selbst vornehmen möchten, beginnen Sie mit einem SvelteKit-Projekt und fügen Sie die Abhängigkeiten hinzu:

bun add @tiramisu-docs/kit @timeleap/tiramisu

Vite-Konfiguration

Konfigurieren Sie das Vite-Plugin in vite.config.ts:

typescript 
import { sveltekit } from "@sveltejs/kit/vite"
import { tiramisuPlugin } from "@tiramisu-docs/kit/vite"
import tailwindcss from "@tailwindcss/vite"
import { defineConfig } from "vite"
import config from "./src/lib/tiramisu.config"

export default defineConfig({
  plugins: [tiramisuPlugin({ config }), tailwindcss(), sveltekit()],
  resolve: { conditions: ["browser"] },
})

Tiramisu-Konfiguration

Erstellen Sie src/lib/tiramisu.config.ts:

typescript 
import { defineConfig } from "@tiramisu-docs/kit"

export default defineConfig({
  title: "My Docs",
  description: "Documentation for my project",
  nav: [{ label: "Docs", href: "/docs" }],
})

Theme-Einrichtung

Importieren Sie das Theme in src/app.css:

css 
@import "@tiramisu-docs/kit/styles/theme.css";
@import "tailwindcss";

@source "../node_modules/@tiramisu-docs/kit/src/lib";