docs: improve usage instructions

catppuccin · Sep 7, 2024 · 9076887 · 9076887
1 parent b53e700
commit 9076887
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -36,9 +36,10 @@
 
 ## Usage
 
-1. Install the theme using `npm install 42willow/vitepress`
+1. Install the theme package to your project with `npm install @catppuccin/vitepress`.
+
+2. Add the theme to your VitePress theme configuration file:
 
-2. Import the theme
    `.vitepress/theme/index.ts`
 
    ```ts
@@ -48,9 +49,10 @@
    export default DefaultTheme;
    ```
 
-   See [extending the default theme](https://vitepress.dev/guide/extending-default-theme#extending-the-default-theme) for more information.
+   See ["Extending the Default Theme | VitePress"](https://vitepress.dev/guide/extending-default-theme#extending-the-default-theme) for more information.
+
+3. Configure syntax highlighting in your VitePress configuration file:
 
-3. Set syntax highlighting to Catppuccin
    `.vitepress/config.mts`
 
    ```ts

diff --git a/site/.vitepress/config.mts b/site/.vitepress/config.mts
@@ -6,6 +6,7 @@ export default defineConfig({
   description: "A VitePress theme",
   srcDir: "./src",
   base: "/vitepress/",
+  // https://vitepress.dev/guide/markdown#syntax-highlighting-in-code-blocks
   markdown: {
     theme: {
       light: "catppuccin-latte",

diff --git a/site/src/install.md b/site/src/install.md
@@ -1,27 +1,28 @@
 # Usage
 
-1. Install the theme using your preferred package manager
+1. Install the theme package to your project with your preferred package manager:
+
    ::: code-group
 
    ```bash [npm]
-   npm install 42willow/vitepress
+   npm install @catppuccin/vitepress
    ```
 
    ```bash [Yarn]
-   yarn add git+https://github.com/42willow/vitepress.git
+   yarn add @catppuccin/vitepress
    ```
 
    ```bash [pnpm]
-   pnpm add github:42willow/vitepress
+   pnpm add @catppuccin/vitepress
    ```
 
    ```bash [Bun]
-   bun add github:42willow/vitepress
+   bun add @catppuccin/vitepress
    ```
 
    :::
 
-2. Import the theme
+2. Add the theme to your VitePress theme configuration file:
 
    ::: code-group
 
@@ -34,12 +35,13 @@
 
    :::
 
-   See [extending the default theme](https://vitepress.dev/guide/extending-default-theme#extending-the-default-theme) for more information.
+   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. Set syntax highlighting to Catppuccin
+3. Configure syntax highlighting in your VitePress configuration file:
+
    ::: code-group
 
    ```ts{6} [.vitepress/config.mts]