Getting started

Install

pnpm add i-cant-believe-its-not-vitepress

Add it to your config

The theme is a Starlight plugin. Add it to plugins and you are done — there is nothing to import into your own CSS.

import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import vitepress from 'i-cant-believe-its-not-vitepress';

export default defineConfig({
  integrations: [
    starlight({
      title: 'My docs',
      plugins: [vitepress()],
    }),
  ],
});

Options

Every option has a sensible default; you can pass nothing at all.

vitepress({
  // Self-host Inter (variable, with the optical sizing axis).
  fonts: true,
  // Widest the whole layout is allowed to get.
  layoutMaxWidth: '88rem',
  // Use VitePress's Shiki themes and code block chrome.
  syntaxHighlighting: true,
});

Next

Configuration — every option in detail.
Styling — the custom properties to reach for when you want a different accent colour or a wider content column.