Skip to content

Commit

Permalink
docs: document new :tailwind/files
Browse files Browse the repository at this point in the history
Add documentation for the `:tailwind/files` configuration.
  • Loading branch information
rschmukler committed Jul 3, 2021
1 parent c86c611 commit 03c47bf
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ shadow's own `deps` or in your `deps.edn` file).

```clj
{com.teknql/shadow-cljs-tailwind-jit
{:mvn/version "0.2.0"}}
{:mvn/version "0.2.2"}}
```

Next, add the required build hooks to your `shadow-cljs.edn` build configuration:
Expand Down Expand Up @@ -54,6 +54,19 @@ The following options are supported via namespaced keys within the `shadow-cljs`
Note that editing either the `:tailwind/config` or `:postcss/config` could result in incompatible
configurations, so please be careful.

### Using with Tailwind Config Files

If your project is sufficiently complex, you may be best off using the
`tailwind.config.js`, `postcss.config.js`, and a `.css` file entrypoint. In this
case you're just using shadow to manage your postcss process. To do this you can
use the `:tailwind/files` variable.

```clj
{:tailwind/files
{:base-path "./path" ;; Path to directory housing `tailwind.config.js` and `postcss.config.js`
:tailwind.css "./path/style.css"}} ;; Path to tailwind entrypoint
```

## FAQ

### How is this different from [jacekschae/shadow-cljs-tailwindcss](https://github.com/jacekschae/shadow-cljs-tailwindcss)?
Expand Down

0 comments on commit 03c47bf

Please sign in to comment.