Skip to content

Commit 5e82495

Browse files
Merge pull request #3167 from vuestorefront/v2-release/nuxt-2.5.1
chore: release/[email protected]
2 parents 2a77bee + 2f0cc80 commit 5e82495

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed

.changeset/ninety-weeks-tell.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@storefront-ui/nuxt": patch
3+
---
4+
5+
[FIXED] README.md file update, especially instalation process and required dependencies

.github/workflows/ci.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ on:
1313
- ready_for_review
1414
- edited
1515

16+
concurrency:
17+
group: ${{ github.workflow }}-${{ github.ref }}
18+
cancel-in-progress: true
19+
1620
env:
1721
SONAR_TOKEN_REACT: ${{ secrets.SONAR_TOKEN_REACT }}
1822
SONAR_TOKEN_VUE: ${{ secrets.SONAR_TOKEN_VUE }}

packages/sfui/frameworks/nuxt/README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
1-
21
### Install all dependencies
32

4-
With Nuxt 3, the fastest way to get started is to use the `@storefront-ui/nuxt` module. The [Storefront-io Nuxt module](https://www.npmjs.com/package/@storefront-ui/nuxt) will automatically install `@nuxtjs/tailwindcss` and storefront-ui tailwindcss presets.
5-
6-
Additionally, you'll need to install the Storefront UI's Vue library and NuxtJs Tailwindcss Module.
3+
With Nuxt 3, the fastest way to get started is to use the `@storefront-ui/nuxt` module. The [Storefront-io Nuxt module](https://www.npmjs.com/package/@storefront-ui/nuxt) will automatically install `@nuxtjs/tailwindcss` inside `nuxt` and storefront-ui tailwindcss presets.
74

85
```bash
96
# npm
10-
npm i -D @storefront-ui/nuxt @storefront-ui/vue @nuxtjs/tailwindcss
7+
npm i -D @storefront-ui/nuxt
118

129
# yarn
13-
yarn add -D @storefront-ui/nuxt @storefront-ui/vue @nuxtjs/tailwindcss
10+
yarn add -D @storefront-ui/nuxt
1411

1512
# pnpm
16-
pnpm add -D @storefront-ui/nuxt @storefront-ui/vue @nuxtjs/tailwindcss
13+
pnpm add -D @storefront-ui/nuxt
1714
```
1815

1916
### Add the Nuxt Tailwind module to your `nuxt.config.ts`
@@ -29,11 +26,11 @@ export default defineNuxtConfig({
2926

3027
Since we use `@nuxtjs/tailwindcss` under the hood, there is possibility to use `tailwindcss` property in `nuxt.config.ts` file. Other than that there is default `tailwind` way to create config via `tailwind.config.ts` file.
3128

32-
Priority of reading configuration, in most important from top to bottom:
29+
Internally, `@nuxtjs/tailwindcss` will merge the three places that you can add configurations. In order of priority, the options are:
3330

3431
1. `tailwind.config.ts` file
3532
2. `nuxt.config.ts` file with `tailwindcss` property
36-
3. default configuration inside module
33+
3. Storefront UI [default configuration](https://github.com/vuestorefront/storefront-ui/blob/v2-develop/packages/config/tailwind/index.ts)
3734

3835
::tip Add a path to your installed package
3936
In order for Tailwind to properly detect the utility classes used in Storefront UI components, you need to add a path to wherever your `node_modules` folder is located to the `content` property. In the example below, we're using the default location for `node_modules`, but this may change if you're working in a monorepo.
@@ -61,4 +58,4 @@ If you're going to create your own Tailwind CSS file, make sure to add the @tail
6158

6259
### You're ready to go
6360

64-
Now, you can import Storefront UI components in your app and all the Tailwind utilities from the `@storefront-ui/vue` library will be available in your project. Because `storefront-ui` is served as well from module, `@storefront-ui/vue` is available from [nuxt autoimport](https://nuxt.com/docs/guide/concepts/auto-imports).
61+
Now, you can import Storefront UI components in your app and all the Tailwind utilities from the `@storefront-ui/vue` library will be available in your project. Because `storefront-ui` is served as well from module, `@storefront-ui/vue` is available from [Nuxt autoimport](https://nuxt.com/docs/guide/concepts/auto-imports).

0 commit comments

Comments
 (0)