Documentation template for Ilha

Launch a polished docs site without starting from a blank page.

Luz is a reusable Ilha starter with MDX pages, searchable content, static output, and Areia UI components already wired together.

Getting Started Writing Guide

npx giget@latest gh:ilhajs/luz my-docs

Vite

Fast local development

TypeScript

Typed app structure

Tailwind v4

Utility-first styling

Prerendering

Static output ready

What is included

A practical foundation for your docs.

Keep the template brand-neutral, then replace the sample pages and navigation with your project’s content.

File-based documentation routes

Create pages from src/pages with nested guide routes, shared layouts, and content-first URLs.

src
├─ lib
│  ├─ components
│  │  ├─ search.tsx
│  │  └─ sidebar.tsx
│  └─ mdx.ts
└─ pages
   ├─ index.tsx
   ├─ +layout.tsx
   └─ (content)
      ├─ getting-started.mdx
      └─ guide
         └─ writing.mdx

MDX-ready authoring

Write docs in MDX with Markdown, syntax-highlighted code, and embedded Ilha islands or Areia components right where readers need them.

import { Button } from "areia"

# Writing great docs

Use Markdown for prose, lists, and examples.

```ts
const path = "/guide/writing"
```

<Button>Try it</Button>

Built-in command search

MiniSearch powers a fast ⌘K overlay that indexes page titles and body text out of the box.

Search documentation...⌘K

Getting Started

Writing

Static output, simple deployment

Build prerendered pages that can be hosted almost anywhere: Vercel, Netlify, GitHub Pages, Cloudflare, or any static file server.

$ bun run build
✓ dist/index.html
✓ dist/getting-started/index.html
✓ dist/guide/writing/index.html

Deploy the dist/ folder anywhere.

Make it yours.

Update the MDX pages, extend the sidebar, and publish a documentation site that still feels like your product—not the starter.

Start editing GitHub