Skip to content

Commit

Permalink
docs(core): fix wrong tailwind content path (#123)
Browse files Browse the repository at this point in the history
  • Loading branch information
zlatanpham authored Nov 10, 2023
1 parent aa4c16f commit e8309e8
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,25 @@ import { consolelabs } from '@consolelabs/core'
module.exports = {
content: [
// ...
'./node_modules/@consolelabs/theme/src/components/**/*.{js,jsx,ts,tsx}',
'./node_modules/@consolelabs/theme/dist/components/**/*.{js,jsx,ts,tsx}',
],
plugins: [consolelabs()],
}
```

**3. Configuring pnpm (Optional)**

For those utilizing pnpm, it's necessary to modify your `.npmrc` file with the
following code. This step ensures that the package paths align correctly,
allowing TailwindCSS to accurately interpret Tailwind class names:

```sh
public-hoist-pattern[]=*@consolelabs/*
```

Once you've updated the `.npmrc` file, execute pnpm install once more to
guarantee proper installation of the dependencies.

### Individual Installation

Console Labs UI also supports modular installation, allowing you to install
Expand Down Expand Up @@ -110,6 +123,19 @@ function App() {
}
```

**5. Configuring pnpm (Optional)**

For those utilizing pnpm, it's necessary to modify your `.npmrc` file with the
following code. This step ensures that the package paths align correctly,
allowing TailwindCSS to accurately interpret Tailwind class names:

```sh
public-hoist-pattern[]=*@consolelabs/*
```

Once you've updated the `.npmrc` file, execute pnpm install once more to
guarantee proper installation of the dependencies.

## Design Philosophy

Console Labs UI adheres to key principles ensuring consistency and reliability
Expand Down

1 comment on commit e8309e8

@vercel
Copy link

@vercel vercel bot commented on e8309e8 Nov 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

websites-mochi – ./apps/mochi-web

websites-mochi.vercel.app
websites-mochi-git-main-consolelabs.vercel.app
beta.mochi.gg
websites-mochi-consolelabs.vercel.app

Please sign in to comment.