Tiramisu Docs

Getting Started

Installation

Installez Tiramisu Docs via l'outil de création ou manuellement avec SvelteKit, Vite et Tailwind CSS.

Outil de création

Le moyen le plus rapide de commencer est d'utiliser l'outil de création :

bun create tiramisu-docs my-docs

L'outil de création vous posera des questions sur les sections et l'i18n. Une fois terminé :

cd my-docs
bun install
bun run dev

Installation manuelle

Si vous préférez tout configurer vous-même, commencez par un projet SvelteKit et ajoutez les dépendances :

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

Configuration de Vite

Configurez le plugin Vite dans 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"] },
})

Configuration de Tiramisu

Créez 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" }],
})

Configuration du thème

Importez le thème dans src/app.css :

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

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