Skip to content

Usage

  1. Install the theme package to your project with your preferred package manager:

    bash
    npm install @catppuccin/vitepress
    bash
    yarn add @catppuccin/vitepress
    bash
    pnpm add @catppuccin/vitepress
    bash
    bun add @catppuccin/vitepress
  2. Add the theme to your VitePress theme configuration file:

    ts
    import DefaultTheme from "vitepress/theme";
    import "@catppuccin/vitepress/theme/<flavor>/<accent>.css";
    
    export default DefaultTheme;

    NOTE

    Latte is included in all flavors as the light mode variant.

    See "Extending the Default Theme | VitePress" for more information.

  3. Configure syntax highlighting in your VitePress configuration file:

    ts
    export default defineConfig({
      // ...
      markdown: {
        theme: {
          light: 'catppuccin-latte',
          dark: 'catppuccin-<flavor>',
        },
      },
      // ...
    });

 

Copyright © 2021-present Catppuccin Org