Tiramisu Docs

Getting Started

Installation

Install Tiramisu Docs using the scaffolder or set up manually with SvelteKit and the Vite plugin.

Scaffolder

The fastest way to get started is with the scaffolder:

bun create tiramisu-docs my-docs

The scaffolder will ask you about sections and i18n. Once done:

cd my-docs
bun install
bun run dev

Manual Setup

If you prefer to set things up yourself, start with a SvelteKit project and add the dependencies:

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

Vite Configuration

Configure the 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 Configuration

Create 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 Setup

Import the theme in src/app.css:

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

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