Skip to content

Commit

Permalink
docs: update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
42willow committed Jul 15, 2024
1 parent 3e52469 commit 357e666
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

## Usage

1. Install the theme using `npm install 42willow/vitepress#main`
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)

Expand Down
Binary file modified example/bun.lockb
Binary file not shown.
16 changes: 7 additions & 9 deletions example/package.json
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
{
"description": "📝 Soothing pastel theme for VitePress",
"author": "willow <[email protected]>",
"license": "MIT",
"scripts": {
"build": "vitepress build",
"dev": "vitepress dev",
"preview": "vitepress preview"
},
"devDependencies": {
"@catppuccin/vitepress": "github:42willow/vitepress",
"@types/bun": "latest",
"vitepress": "^1.2.3"
},
"peerDependencies": {
"typescript": "^5.0.0"
},
"dependencies": {
"@catppuccin/vitepress": "../"
"description": "📝 Soothing pastel theme for VitePress",
"license": "MIT",
"scripts": {
"build": "vitepress build",
"dev": "vitepress dev",
"preview": "vitepress preview"
}
}
8 changes: 4 additions & 4 deletions example/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
::: code-group

```bash [npm]
npm install 42willow/vitepress#main
npm install 42willow/vitepress
```
```bash [Yarn]
yarn add 42willow/vitepress#main
yarn add git+https://github.com/42willow/vitepress.git
```
```bash [pnpm]
pnpm add 42willow/vitepress#main
pnpm add github:42willow/vitepress
```
```bash [Bun]
bun add 42willow/vitepress#main
bun add github:42willow/vitepress
```
:::

Expand Down

0 comments on commit 357e666

Please sign in to comment.