Skip to content

Commit

Permalink
docs: update usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
42willow committed Sep 5, 2024
1 parent 7ff46b6 commit a3cbdd0
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,18 @@
## Usage

1. Install the theme using `npm install 42willow/vitepress`
2. Import the theme as shown [here](./example/.vitepress/theme/index.ts)
3. Add your preferred accent overrides to an `override.css` file as shown [here](./example/.vitepress/theme/override.css)
2. Import the theme

`.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](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.
Expand Down
14 changes: 12 additions & 2 deletions example/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,18 @@
```
:::

2. Import the theme as shown [here](./example/.vitepress/theme/index.ts)
3. Add your preferred accent overrides to an `override.css` file as shown [here](./example/.vitepress/theme/override.css)
2. Import the theme

`.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](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.
Expand Down

0 comments on commit a3cbdd0

Please sign in to comment.