vitepress

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 93 Open GitHub ↗

📝 Soothing pastel theme for VitePress

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h3 align="center">
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
	Catppuccin for <a href="https://github.com/vuejs/vitepress">VitePress</a>
	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
</h3>

## Previews

<details>
<summary>🌻 Latte</summary>
<img src="https://raw.githubusercontent.com/catppuccin/vitepress/main/assets/latte.webp"/>
</details>
<details>
<summary>🪴 Frappé</summary>
<img src="https://raw.githubusercontent.com/catppuccin/vitepress/main/assets/frappe.webp"/>
</details>
<details>
<summary>🌺 Macchiato</summary>
<img src="https://raw.githubusercontent.com/catppuccin/vitepress/main/assets/macchiato.webp"/>
</details>
<details>
<summary>🌿 Mocha</summary>
<img src="https://raw.githubusercontent.com/catppuccin/vitepress/main/assets/mocha.webp"/>
</details>

## Usage

1. Install the theme package to your project with `npm install @catppuccin/vitepress`.

2. Add the theme to your VitePress theme configuration file:

`.vitepress/theme/index.ts`

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

export default DefaultTheme;
   ```

See ["Extending the Default Theme | VitePress"](https://vitepress.dev/guide/extending-default-theme#extending-the-default-theme) for more information.

> [!NOTE]
> Latte is included in all flavors as the light mode variant.

3. Configure syntax highlighting in your VitePress configuration file:

`.vitepress/config.mts`

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

## 💝 Thanks to

- [42Willow](https://github.com/42willow)
- [Strata Docs](https://github.com/StrataWM/strata/blob/5daa4f102a7a03bb73dbe84e43d7ae1cb64d2c54/docs/.vitepress/theme/colors.css)

&nbsp;

vitepress

Today's picks

Was this content helpful?

Recent Feedback

vitepress

Today's picks

Was this content helpful?

Recent Feedback

Download README