Skip to content

Commit

Permalink
docs(example): update installation page
Browse files Browse the repository at this point in the history
  • Loading branch information
42willow committed Jul 15, 2024
1 parent fa6e38a commit 6c4ebca
Showing 1 changed file with 37 additions and 4 deletions.
41 changes: 37 additions & 4 deletions example/src/install.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,38 @@
# Install
# Usage

::: info
Coming soon
:::
1. Install the theme using your preferred package manager:
::: code-group

```bash [npm]
npm install 42willow/vitepress#main
```
```bash [Yarn]
yarn add 42willow/vitepress#main
```
```bash [pnpm]
pnpm add 42willow/vitepress#main
```
```bash [Bun]
bun add 42willow/vitepress#main
```
:::

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)

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

<p align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" />
</p>

<p align="center">
Copyright &copy; 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
</p>

<p align="center">
<a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
</p>

0 comments on commit 6c4ebca

Please sign in to comment.