Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
149 additions
and
141 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
name: "\U0001F41E Bug report" | ||
description: Report a bug report to help us improve the module | ||
labels: ["bug"] | ||
body: | ||
- type: textarea | ||
id: bug-env | ||
attributes: | ||
label: Environment | ||
description: Use `npx nuxi info` to fill this section. | ||
placeholder: Environment | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduction | ||
attributes: | ||
label: Reproduction | ||
description: A link to a repo that can reproduce the problem you ran into, or over a web container like Stackblitz using [our template](https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/docs-examples/examples/basic-usage). | ||
placeholder: Reproduction | ||
- type: textarea | ||
id: bug-description | ||
attributes: | ||
label: Describe the bug | ||
description: A clear and concise description of what the bug is. | ||
placeholder: Bug description | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additonal | ||
attributes: | ||
label: Additional context | ||
description: If applicable, add any other context about the problem here. | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Logs | ||
description: | | ||
Optional if provided reproduction. Please try not to insert an image but copy paste the log text. | ||
render: shell-script |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,17 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Nuxt Community Discord | ||
url: https://discord.nuxtjs.org/ | ||
about: Consider asking questions about the module here. | ||
- name: 📚 Nuxt Documentation | ||
url: https://nuxt.com/docs | ||
about: Check the documentation for usage of Nuxt | ||
- name: 💬 Nuxt Discussions | ||
url: https://github.com/nuxt/nuxt/discussions | ||
about: Check if there is anything related to your issue on Nuxt discussions | ||
- name: 📚 Tailwind CSS Documentation | ||
url: https://tailwindcss.com/docs | ||
about: Check the documentation for usage of Tailwind CSS | ||
- name: 💬 Tailwind CSS GitHub | ||
url: https://github.com/tailwindlabs/tailwindcss | ||
about: Check if there is anything related to your issue on the Tailwind CSS repository | ||
- name: 👥 Nuxt Discord Server | ||
url: https://chat.nuxt.dev/ | ||
about: Consider asking questions about the module here |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
name: "🚀 Feature request" | ||
description: Suggest an idea or enhancement for the module | ||
labels: ["enhancement"] | ||
body: | ||
- type: textarea | ||
id: feature-description | ||
attributes: | ||
label: Describe the feature | ||
description: A clear and concise description of what you think would be a helpful addition to the module, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link. | ||
placeholder: Feature description | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: additional-info | ||
attributes: | ||
label: Additional information | ||
description: Additional information that helps us decide how to proceed. | ||
options: | ||
- label: Would you be willing to help implement this feature? | ||
- label: Could this feature be implemented as a module? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,14 @@ | ||
--- | ||
name: Question | ||
about: Ask a question about the module. | ||
name: ❓ Question | ||
about: Ask a question about the module | ||
title: '' | ||
labels: 'question' | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- **IMPORTANT!** | ||
Please make sure to look for an answer to your question in our documentation and the Tailwindcss documentation before asking a question here. | ||
Please make sure to look for an answer to your question in our documentation and the Tailwind CSS documentation before asking a question here. | ||
If you have a general question regarding Nuxt-Tailwindcss use Discord `modules` channel. Thanks! | ||
Nuxt Discord: https://discord.nuxtjs.org/ | ||
If you have a general question regarding this module, use the Discord server: https://chat.nuxt.dev/ | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
--- | ||
title: Basic Usage | ||
description: Live example of basic usage of Nuxt and Tailwind CSS. | ||
description: Example usage of the module. | ||
toc: false | ||
--- | ||
|
||
Here is a minimal example of a Nuxt project using the Tailwind CSS module. | ||
This is a minimal example of a Nuxt project using the Tailwind CSS module. | ||
|
||
:sandbox{src="https://stackblitz.com/edit/nuxt-tailwindcss-starter?embed=1&file=pages%2Findex.vue"} | ||
:sandbox{src="https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/docs-examples/examples/basic-usage"} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,20 @@ | ||
--- | ||
title: Dark Mode | ||
description: Live example of dark mode with Nuxt Tailwind. | ||
description: Example of enabling dark mode with the module. | ||
toc: false | ||
--- | ||
|
||
This is an example using the [Tailwind Dark Mode](https://tailwindcss.com/docs/dark-mode) and [@nuxtjs/color-mode](https://github.com/nuxt-modules/color-mode) module. | ||
|
||
To make it work hand-in-hand, you need to update your `tailwind.config` by adding the following: | ||
|
||
```ts [tailwind.config.ts] | ||
import type { Config } from 'tailwindcss' | ||
|
||
export default <Partial<Config>>{ | ||
darkMode: 'class' | ||
} | ||
``` | ||
|
||
And, add the `classSuffix` to the colorMode module options: | ||
This is an example using the [Tailwind Dark Mode](https://tailwindcss.com/docs/dark-mode) with the help of [`@nuxtjs/color-mode`](https://github.com/nuxt-modules/color-mode) module. | ||
|
||
```ts [nuxt.config.ts] | ||
export default defineNuxtConfig({ | ||
modules: [ | ||
'@nuxtjs/tailwindcss', | ||
'@nuxtjs/color-mode' | ||
], | ||
colorMode: { | ||
classSuffix: '' | ||
} | ||
}) | ||
``` | ||
|
||
See the working demo below: | ||
|
||
:sandbox{src="https://stackblitz.com/edit/nuxt-tailwindcss-color-mode?embed=1&file=app.vue"} | ||
:sandbox{src="https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/docs-examples/examples/dark-mode"} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: Nuxt Content | ||
description: Discover how powerful it is to use Tailwind CSS with Markdown files. | ||
--- | ||
|
||
The module is extended by [`@nuxt/content`](https://content.nuxt.com/), meaning you can use Tailwind classes inside your content files with MDC syntax! | ||
|
||
```md | ||
Hello, this is a [Markdown]{.px-1 .bg-blue-200 .rounded-lg} file! | ||
|
||
::div{.w-full .bg-green-200 .p-4} | ||
Another way to use it! | ||
:: | ||
``` | ||
|
||
Learn more about the [Span Syntax](https://content.nuxt.com/usage/markdown#span-text) and how to use classes in Markdown files! | ||
|
||
:sandbox{src="https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/docs-examples/examples/nuxt-content"} |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Tailwind Plugins | ||
description: Example of using Tailwind plugins. | ||
--- | ||
|
||
In this example, we add the [`tailwindcss-icons`](https://github.com/egoist/tailwindcss-icons) plugin. | ||
|
||
:sandbox{src="https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/docs-examples/examples/tailwind-plugins"} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: PostCSS Configuration | ||
description: Example of customising PostCSS options for Nuxt. | ||
toc: false | ||
--- | ||
|
||
<!-- TODO: Replace with another postcss plugin as tailwind supports gray colors natively. --> | ||
|
||
In this example, we add [`postcss-color-gray`](https://github.com/postcss/postcss-color-gray) as a PostCSS plugin. | ||
|
||
See [`postcss`](https://nuxt.com/docs/api/nuxt-config#postcss) options in Nuxt. | ||
|
||
:sandbox{src="https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/docs-examples/examples/postcss-config"} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: DaisyUI | ||
description: Example of using the module with daisyUI and color mode. | ||
toc: false | ||
--- | ||
|
||
Example with [daisyUI](https://daisyui.com/) and [`@nuxtjs/color-mode`](https://color-mode.nuxtjs.org/). | ||
|
||
:sandbox{src="https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/docs-examples/examples/daisyui"} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Flowbite | ||
description: Example of usage with Flowbite. | ||
--- | ||
|
||
[Flowbite](https://flowbite.com) is a set of open source components on top of Tailwind CSS. | ||
|
||
:sandbox{src="https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/docs-examples/examples/flowbite"} |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: Nuxt UI | ||
description: Example of Nuxt UI. | ||
toc: false | ||
--- | ||
|
||
Checkout [Nuxt UI](https://ui.nuxt.com) documentation. | ||
|
||
:sandbox{src="https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/docs-examples/examples/nuxtui"} |