Skip to content

Commit 078772c

Browse files
authored
docs: update outdated content (#937)
1 parent 3a7a8a0 commit 078772c

33 files changed

+458
-494
lines changed

README.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,19 @@
99
[![Tailwind CSS][tw-src]][tw-href]
1010
[![Volta board][volta-src]][volta-href]
1111

12-
[Tailwind CSS](https://tailwindcss.com) module for [Nuxt](https://nuxt.com) ⚡️
12+
Enable [Tailwind CSS](https://tailwindcss.com) for [Nuxt](https://nuxt.com) ⚡️
1313

14-
- [ Release Notes](https://github.com/nuxt-modules/tailwindcss/releases)
15-
- [▶️ Play online](https://stackblitz.com/github/nuxt-modules/tailwindcss)
16-
- [📖  Documentation](https://tailwindcss.nuxtjs.org)
14+
[📖  Documentation](https://tailwindcss.nuxtjs.org) | [▶️ Play online](https://stackblitz.com/github/nuxt-modules/tailwindcss) | [ Release Notes](https://github.com/nuxt-modules/tailwindcss/releases)
1715

1816
## Features
1917

2018
- 👌  Zero configuration to start
2119
- 🪄  Includes [CSS Nesting](https://drafts.csswg.org/css-nesting-1/) with [postcss-nesting](https://github.com/csstools/postcss-nesting)
22-
- 🎨  Discover your Tailwind Config & Colors *([see video](https://tailwindcss.nuxtjs.org/tailwind/viewer))*
23-
- ⚙️  [Reference your Tailwind config](https://tailwindcss.nuxtjs.org/tailwind/config/#referencing-in-the-application) in your app
24-
- 📦  Extendable by [Nuxt modules](https://nuxt.com/modules) using [hooks](https://tailwindcss.nuxtjs.org/tailwind/config#hooks)
20+
- 🎨  Discover your Tailwind Config & Colors *([see video](https://tailwindcss.nuxtjs.org/getting-started/module-options#viewer))*
21+
- ⚙️  [Reference your Tailwind config](https://tailwindcss.nuxtjs.org/tailwindcss/configuration/#referencing-in-the-application) in your app
22+
- 📦  Extendable by [Nuxt modules](https://nuxt.com/modules) using [hooks](https://tailwindcss.nuxtjs.org/tailwindcss/config#hooks)
2523
- 🚀  Supports both [Nuxt 3](https://nuxt.com) and [Nuxt 2](https://v2.nuxt.com/)
2624

27-
[📖  Read more](https://tailwindcss.nuxtjs.org)
28-
2925
## Quick Setup
3026

3127
Add `@nuxtjs/tailwindcss` using the [Nuxt CLI](https://github.com/nuxt/cli) to your project
@@ -34,7 +30,9 @@ Add `@nuxtjs/tailwindcss` using the [Nuxt CLI](https://github.com/nuxt/cli) to y
3430
npx nuxi@latest module add tailwindcss
3531
```
3632

37-
or add `@nuxtjs/tailwindcss` using your dependency manager
33+
<details>
34+
35+
<summary>..or install using your dependency manager</summary>
3836

3937
```bash
4038
# Using pnpm
@@ -57,11 +55,10 @@ export default defineNuxtConfig({
5755
})
5856
```
5957

60-
That's it! You can now use Tailwind classes in your Nuxt app ✨
58+
</details>
6159

62-
*You can test latest additions on [Nightly Releases](https://tailwindcss.nuxtjs.org/getting-started/installation#nightly-releases)!*
6360

64-
[📖 &nbsp;Read more](https://tailwindcss.nuxtjs.org/getting-started/)
61+
That's it! You can now use Tailwind classes in your Nuxt app ✨
6562

6663
## Contributing
6764

@@ -70,14 +67,18 @@ You can contribute to this module online:
7067
[![Edit @nuxtjs/tailwindcss in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/nuxt-modules/tailwindcss/tree/main/?fontsize=14&hidenavigation=1&theme=dark)
7168
[![Edit @nuxtjs/tailwindcss in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https://pr.new/nuxt-modules/tailwindcss)
7269

73-
Or locally:
70+
<details>
71+
<summary>..or locally</summary>
7472

7573
1. Clone this repository
7674
2. Install dependencies using `pnpm i`
7775
3. Prepare for development using `pnpm dev:prepare`
7876
4. Start development server using `pnpm dev`
7977

78+
</details>
79+
8080
### Docs
81+
8182
[![Nuxt UI Pro](https://img.shields.io/badge/Made%20with-Nuxt%20UI%20Pro-00DC82?logo=nuxt.js&labelColor=020420)](https://ui.nuxt.com/pro)
8283

8384
You can run `docs/` locally by using `pnpm docs:dev`, or to run a build:
@@ -102,7 +103,7 @@ Check out the [deployment documentation](https://nuxt.com/docs/getting-started/d
102103
[license-src]: https://img.shields.io/npm/l/@nuxtjs/tailwindcss.svg?style=flat&colorA=18181B&colorB=28CF8D
103104
[license-href]: https://npmjs.com/package/@nuxtjs/tailwindcss
104105

105-
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?&logo=nuxt.js
106+
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?&logo=nuxt
106107
[nuxt-href]: https://nuxt.com
107108

108109
[tw-src]: https://img.shields.io/badge/tailwindcss-0F172A?&logo=tailwindcss

docs/app.config.ts docs/app/app.config.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { version as pkgVersion } from '../package.json'
1+
import { version as pkgVersion } from '../../package.json'
22

33
export default defineAppConfig({
44
ui: {
5-
primary: 'green',
5+
primary: 'sky',
66
gray: 'slate',
77
footer: {
88
bottom: {
@@ -21,6 +21,7 @@ export default defineAppConfig({
2121
},
2222
},
2323
header: {
24+
pkgVersion,
2425
logo: {
2526
light: {
2627
src: '',

docs/app.vue docs/app/app.vue

File renamed without changes.

docs/components/AdsUIPro.vue docs/app/components/AdsUIPro.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@
489489
</UBadge>
490490
</div>
491491
<p class="text-sm dark:text-gray-400 text-gray-500 pb-1">
492-
Building Blocks with Nuxt Tailwind.
492+
Building Blocks with Tailwind CSS and Nuxt.
493493
</p>
494494
</UPageCard>
495495
</template>

docs/components/AppFooter.vue docs/app/components/AppFooter.vue

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ const { footer } = useAppConfig()
66
<UFooter>
77
<template #left>
88
<span class="text-sm text-gray-500 dark:text-gray-400">
9-
© 2024 | <NuxtLink
9+
© 2025 | <NuxtLink
1010
to="https://github.com/nuxt-modules/tailwindcss/blob/main/LICENSE"
1111
target="_blank"
1212
class="text-gray-900 dark:text-white"
13-
>MIT License</NuxtLink> | v{{ footer.pkgVersion }}
13+
>MIT License</NuxtLink>
1414
</span>
1515
</template>
1616

docs/components/AppHeader.vue docs/app/components/AppHeader.vue

+6
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ const { header } = useAppConfig()
1010
<UHeader>
1111
<template #logo>
1212
<TheLogo class="h-6" />
13+
<TailwindText class="h-4" />
14+
<UTooltip v-if="header.pkgVersion" :text="`Latest release: v${header.pkgVersion}`">
15+
<UBadge variant="subtle" size="xs" class="-mb-[2px] rounded font-semibold">
16+
v{{ header.pkgVersion.match(/[0-9]+\.[0-9]+/)[0] }}
17+
</UBadge>
18+
</UTooltip>
1319
</template>
1420

1521
<template

docs/app/components/TailwindText.vue

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<template>
2+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 377.44 55.32">
3+
<path
4+
fill="currentColor"
5+
d="M24.12,24.87H14.89V42.73c0,4.77,3.13,4.69,9.23,4.4v7.22C11.76,55.84,6.85,52.41,6.85,42.73V24.87H0V17.12H6.85v-10l8-2.38V17.12h9.23Zm35.19-7.75h8V54.35h-8V49c-2.83,3.94-7.22,6.33-13,6.33-10.12,0-18.53-8.57-18.53-19.58s8.41-19.58,18.54-19.58c5.8,0,10.2,2.38,13,6.25ZM47.55,47.65A11.5,11.5,0,0,0,59.31,35.74,11.5,11.5,0,0,0,47.55,23.83,11.5,11.5,0,0,0,35.79,35.74,11.5,11.5,0,0,0,47.55,47.65ZM80.76,11.54A5.2,5.2,0,0,1,75.62,6.4a5.14,5.14,0,1,1,10.27,0A5.19,5.19,0,0,1,80.76,11.54Zm-4,42.81V17.12h8V54.35Zm17.34,0V0h8V54.35Zm60.23-37.23h8.49L151.11,54.35h-7.89l-7.75-25.09-7.81,25.09h-7.89L108.08,17.12h8.49l7.22,25.69,7.81-25.69h7.67L147,42.81Zm18.47-5.58a5.2,5.2,0,0,1-5.14-5.14,5.14,5.14,0,1,1,10.27,0A5.19,5.19,0,0,1,172.78,11.54Zm-4,42.81V17.12h8V54.35Zm36.92-38.2c8.34,0,14.3,5.66,14.3,15.34V54.35h-8v-22c0-5.66-3.28-8.63-8.34-8.63-5.29,0-9.46,3.12-9.46,10.72v20h-8V17.12h8v4.77c2.46-3.87,6.48-5.74,11.54-5.74ZM258.1,2.23h8V54.35h-8V49c-2.83,3.94-7.23,6.33-13,6.33-10.13,0-18.54-8.57-18.54-19.58s8.41-19.58,18.54-19.58c5.8,0,10.2,2.38,13,6.25ZM246.33,47.65a11.5,11.5,0,0,0,11.76-11.91,11.76,11.76,0,1,0-23.52,0A11.5,11.5,0,0,0,246.33,47.65Zm46.76,7.67a19.26,19.26,0,0,1-19.66-19.58,19.2,19.2,0,0,1,19.66-19.58,18.39,18.39,0,0,1,16.6,9.6l-6.93,4c-1.63-3.5-5.28-5.73-9.75-5.73a11.36,11.36,0,0,0-11.54,11.69A11.35,11.35,0,0,0,293,47.42a10.9,10.9,0,0,0,9.9-5.73l6.93,4a18.73,18.73,0,0,1-16.75,9.68Zm30-27.92c0,6.77,20,2.68,20,16.45,0,7.45-6.48,11.47-14.52,11.47-7.45,0-12.81-3.35-15.19-8.71l6.92-4c1.2,3.35,4.17,5.36,8.27,5.36,3.57,0,6.33-1.19,6.33-4.17,0-6.63-20-2.91-20-16.23,0-7,6-11.39,13.62-11.39,6.11,0,11.17,2.83,13.78,7.74l-6.78,3.8a7.25,7.25,0,0,0-7-4.25c-2.9,0-5.43,1.27-5.43,3.95Zm34.32,0c0,6.77,20,2.68,20,16.45,0,7.45-6.48,11.47-14.52,11.47-7.45,0-12.81-3.35-15.19-8.71l6.92-4c1.2,3.35,4.17,5.36,8.27,5.36,3.57,0,6.33-1.19,6.33-4.17,0-6.63-20-2.91-20-16.23,0-7,6-11.39,13.62-11.39C369,16.16,374,19,376.62,23.9l-6.78,3.8a7.24,7.24,0,0,0-7-4.25c-2.91,0-5.44,1.27-5.44,3.95Z"
6+
/>
7+
</svg>
8+
</template>

docs/app/components/TheLogo.vue

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<template>
2+
<svg
3+
viewBox="0 0 825 201"
4+
fill="none"
5+
xmlns="http://www.w3.org/2000/svg"
6+
>
7+
<path
8+
d="M377 200C379.16 200 381 198.209 381 196V103C381 103 386 112 395 127L434 194C435.785 197.74 439.744 200 443 200H470V50H443C441.202 50 439 51.4941 439 54V148L421 116L385 55C383.248 51.8912 379.479 50 376 50H350V200H377Z"
9+
fill="currentColor"
10+
/>
11+
<path
12+
d="M726 92H739C742.314 92 745 89.3137 745 86V60H773V92H800V116H773V159C773 169.5 778.057 174 787 174H800V200H783C759.948 200 745 185.071 745 160V116H726V92Z"
13+
fill="currentColor"
14+
/>
15+
<path
16+
d="M591 92V154C591 168.004 585.742 179.809 578 188C570.258 196.191 559.566 200 545 200C530.434 200 518.742 196.191 511 188C503.389 179.809 498 168.004 498 154V92H514C517.412 92 520.769 92.622 523 95C525.231 97.2459 526 98.5652 526 102V154C526 162.059 526.457 167.037 530 171C533.543 174.831 537.914 176 545 176C552.217 176 555.457 174.831 559 171C562.543 167.037 563 162.059 563 154V102C563 98.5652 563.769 96.378 566 94C567.96 91.9107 570.028 91.9599 573 92C573.411 92.0055 574.586 92 575 92H591Z"
17+
fill="currentColor"
18+
/>
19+
<path
20+
d="M676 144L710 92H684C680.723 92 677.812 93.1758 676 96L660 120L645 97C643.188 94.1758 639.277 92 636 92H611L645 143L608 200H634C637.25 200 640.182 196.787 642 194L660 167L679 195C680.818 197.787 683.75 200 687 200H713L676 144Z"
21+
fill="currentColor"
22+
/>
23+
<path
24+
d="M168 200H279C282.542 200 285.932 198.756 289 197C292.068 195.244 295.23 193.041 297 190C298.77 186.959 300.002 183.51 300 179.999C299.998 176.488 298.773 173.04 297 170.001L222 41C220.23 37.96 218.067 35.7552 215 34C211.933 32.2448 207.542 31 204 31C200.458 31 197.067 32.2448 194 34C190.933 35.7552 188.77 37.96 187 41L168 74L130 9.99764C128.228 6.95784 126.068 3.75491 123 2C119.932 0.245087 116.542 0 113 0C109.458 0 106.068 0.245087 103 2C99.9323 3.75491 96.7717 6.95784 95 9.99764L2 170.001C0.226979 173.04 0.00154312 176.488 1.90993e-06 179.999C-0.0015393 183.51 0.229648 186.959 2 190C3.77035 193.04 6.93245 195.244 10 197C13.0675 198.756 16.4578 200 20 200H90C117.737 200 137.925 187.558 152 164L186 105L204 74L259 168H186L168 200ZM89 168H40L113 42L150 105L125.491 147.725C116.144 163.01 105.488 168 89 168Z"
25+
fill="#0ea5e9"
26+
/>
27+
/>
28+
</svg>
29+
</template>
File renamed without changes.

docs/error.vue docs/app/error.vue

File renamed without changes.
File renamed without changes.

docs/pages/[...slug].vue docs/app/pages/[...slug].vue

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ const { data: surround } = await useAsyncData(`${route.path}-surround`, () => qu
2020
)
2121
2222
useSeoMeta({
23-
titleTemplate: '%s - Nuxt Tailwind',
23+
titleTemplate: '%s - Tailwind CSS module for Nuxt',
2424
title: page.value.title,
25-
ogTitle: `${page.value.title} - Nuxt Tailwind`,
25+
ogTitle: `${page.value.title} - Tailwind CSS module for Nuxt`,
2626
description: page.value.description,
2727
ogDescription: page.value.description,
2828
})
File renamed without changes.

docs/components/TheLogo.vue

-60
This file was deleted.

0 commit comments

Comments
 (0)