diff options
Diffstat (limited to 'packages/integrations/tailwind/README.md')
| -rw-r--r-- | packages/integrations/tailwind/README.md | 19 |
1 files changed, 5 insertions, 14 deletions
diff --git a/packages/integrations/tailwind/README.md b/packages/integrations/tailwind/README.md index ae5bc8458..217bd0c56 100644 --- a/packages/integrations/tailwind/README.md +++ b/packages/integrations/tailwind/README.md @@ -27,7 +27,6 @@ https://user-images.githubusercontent.com/4033662/169920154-4b42fc52-e2b5-4ca4-b <details> <summary>Quick Install</summary> - <br/> The experimental `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one. @@ -48,15 +47,13 @@ Because this command is new, it might not properly set things up. If that happen <details> <summary>Manual Install</summary> -<br/> - First, install the `@astrojs/tailwind` package using your package manager. If you're using npm or aren't sure, run this in the terminal: ```sh npm install @astrojs/tailwind ``` Then, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import tailwind from '@astrojs/tailwind'; @@ -91,12 +88,8 @@ The Astro Tailwind integration handles the communication between Astro and Tailw <details> <summary><strong>config.path</strong></summary> - <br/> - - If you want to use a different Tailwind configuration file instead of the default `tailwind.config.(js|cjs|mjs)`, specify that file's location using this integration's `config.path` option. If `config.path` is relative, it will be resolved relative to the root. - - <br/> - +If you want to use a different Tailwind configuration file instead of the default `tailwind.config.(js|cjs|mjs)`, specify that file's location using this integration's `config.path` option. If `config.path` is relative, it will be resolved relative to the root. + > **Warning** > Changing this isn't recommended since it can cause problems with other tools that integrate with Tailwind, like the official Tailwind VSCode extension. @@ -115,9 +108,7 @@ export default { <details> <summary><strong>config.applyBaseStyles</strong></summary> - - <br/> - + By default, the integration imports a basic `base.css` file on every page of your project. This basic CSS file includes the three main `@tailwind` directives: ```css @@ -167,4 +158,4 @@ This package is maintained by Astro's Core team. You're welcome to submit an iss ## Changelog - +See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. |