Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update configPath documentation #290

Merged
merged 1 commit into from
Mar 15, 2021
Merged

docs: Update configPath documentation #290

merged 1 commit into from
Mar 15, 2021

Conversation

udithishara
Copy link
Contributor

This PR updates tailwind configPath with nuxt srcDir usage documentation in /options page

Note: Original fix provided by @atinux, I'm just updating the documentation

Why?: Cause it took me 2 hours of debugging in the middle of the night to identify the issue

@codecov
Copy link

codecov bot commented Mar 13, 2021

Codecov Report

Merging #290 (537949a) into main (31b7e92) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #290   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           45        45           
  Branches         9         9           
=========================================
  Hits            45        45           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 31b7e92...537949a. Read the comment docs.

@atinux atinux merged commit a133848 into nuxt-modules:main Mar 15, 2021
This was referenced Mar 16, 2021
This was referenced Mar 17, 2021
bors bot referenced this pull request in aDotInTheVoid/xmark-js Mar 18, 2021
100: chore(deps-dev): bump @nuxtjs/tailwindcss from 3.4.3 to 4.0.1 r=aDotInTheVoid a=dependabot[bot]

Bumps [@nuxtjs/tailwindcss](https://github.com/nuxt-community/tailwindcss-module) from 3.4.3 to 4.0.1.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a href="https://github.com/nuxt-community/tailwindcss-module/releases"><code>@​nuxtjs/tailwindcss's releases</code></a>.</em></p>
<blockquote>
<h2>v4.0.1</h2>
<p>Switch from <a href="https://github.com/postcss/postcss-nested">postcss-nested</a> to <a href="https://github.com/csstools/postcss-nesting">postcss-nesting</a> to respect <a href="https://drafts.csswg.org/css-nesting-1/">CSS Nesting</a> spec we supported with version 3 of the module.</p>
<h2>v4.0.0</h2>
<h2>Tailwind 2 with PostCSS 8</h2>
<p>PostCSS 8 is now possible thanks to <a href="https://github.com/nuxt/postcss8"><code>@​nuxt/postcss8</code></a>! No more compatibility build to use the latest version of Tailwind now ✨</p>
<p>Make sure to read the <a href="https://tailwindcss.nuxtjs.org/setup">installation</a> steps.</p>
<h2>Tailwind Just-In-Time</h2>
<p>You may have heard about the <a href="https://github.com/tailwindlabs/tailwindcss-jit">Just-In-Time compilation</a> mode of TailwindCSS, this version supports it, simply set the <code>jit</code> option in your <code>nuxt.config.js</code>:</p>
<pre lang="js"><code>export default {
  buildModules: ['@nuxtjs/tailwindcss'],
  tailwindcss: {
    jit: true
  }
}
</code></pre>
<p>With <code>jit</code> option, our build on nuxtjs.org came from 40s to 7s ⚡</p>
<p><a href="https://tailwindcss.nuxtjs.org">https://tailwindcss.nuxtjs.org</a></p>
<h2>v4.0.0-0</h2>
<h3>Features</h3>
<ul>
<li>upgrade to tailwindcss2 (<a href="https://github.com/nuxt-community/tailwindcss-module/issues/270">#270</a>) (<a href="https://github.com/nuxt-community/tailwindcss-module/commit/8ab33b802005b80cd372e9a268e1c20ac8db8007">8ab33b8</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a href="https://github.com/nuxt-community/tailwindcss-module/blob/main/CHANGELOG.md"><code>@​nuxtjs/tailwindcss's changelog</code></a>.</em></p>
<blockquote>
<h3><a href="https://github.com/nuxt-community/tailwindcss-module/compare/v4.0.0...v4.0.1">4.0.1</a> (2021-03-16)</h3>
<h3>Bug Fixes</h3>
<ul>
<li>use postcss-nesting instead (<a href="https://github.com/nuxt-community/tailwindcss-module/commit/6240fdf331557f4b87a2580c545f3b49ce3faab5">6240fdf</a>)</li>
</ul>
<h2><a href="https://github.com/nuxt-community/tailwindcss-module/compare/v3.4.3...v4.0.0">4.0.0</a> (2021-03-15)</h2>
<h3>⚠ BREAKING CHANGES</h3>
<ul>
<li>v4 (<a href="https://github.com/nuxt-community/tailwindcss-module/issues/287">#287</a>)</li>
</ul>
<h3>Features</h3>
<ul>
<li>v4 (<a href="https://github.com/nuxt-community/tailwindcss-module/issues/287">#287</a>) (<a href="https://github.com/nuxt-community/tailwindcss-module/commit/15a86a9628f9fb941ebe8a6eba62f3b6ab579b04">15a86a9</a>), closes <a href="https://github.com/nuxt-community/tailwindcss-module/issues/270">#270</a> <a href="https://github.com/nuxt-community/tailwindcss-module/issues/276">#276</a> <a href="https://github.com/nuxt-community/tailwindcss-module/issues/288">#288</a></li>
</ul>
<h2><a href="https://github.com/nuxt-community/tailwindcss-module/compare/v4.0.0-11...v4.0.0-12">4.0.0-12</a> (2021-03-15)</h2>
<h2><a href="https://github.com/nuxt-community/tailwindcss-module/compare/v4.0.0-10...v4.0.0-11">4.0.0-11</a> (2021-03-15)</h2>
<h2><a href="https://github.com/nuxt-community/tailwindcss-module/compare/v4.0.0-9...v4.0.0-10">4.0.0-10</a> (2021-03-13)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>revert to using object syntax (<a href="https://github.com/nuxt-community/tailwindcss-module/commit/a8d4acfd3ee60b14858f04a6af5d938276b1aa05">a8d4acf</a>)</li>
</ul>
<h2><a href="https://github.com/nuxt-community/tailwindcss-module/compare/v4.0.0-8...v4.0.0-9">4.0.0-9</a> (2021-03-13)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>dont expose config without option defined (<a href="https://github.com/nuxt-community/tailwindcss-module/commit/d98086e7db5e110891c0c2dd97dbc79d352cef9b">d98086e</a>)</li>
</ul>
<h2><a href="https://github.com/nuxt-community/tailwindcss-module/compare/v4.0.0-7...v4.0.0-8">4.0.0-8</a> (2021-03-12)</h2>
<h2><a href="https://github.com/nuxt-community/tailwindcss-module/compare/v4.0.0-5...v4.0.0-7">4.0.0-7</a> (2021-03-12)</h2>
<h3>Features</h3>
<ul>
<li>tailwind jit (<a href="https://github.com/nuxt-community/tailwindcss-module/issues/288">#288</a>) (<a href="https://github.com/nuxt-community/tailwindcss-module/commit/24dc6c028f9399a58d2e1d73021a9f6532466775">24dc6c0</a>)</li>
</ul>
<h2><a href="https://github.com/nuxt-community/tailwindcss-module/compare/v4.0.0-5...v4.0.0-6">4.0.0-6</a> (2021-03-12)</h2>
<h3>Features</h3>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/nuxt-community/tailwindcss-module/commit/e00da222a62548ad25585ab24d793f596f6c478a"><code>e00da22</code></a> chore(release): 4.0.1</li>
<li><a href="https://github.com/nuxt-community/tailwindcss-module/commit/aa9fc21223b312f75df2da6628fa139396e9932d"><code>aa9fc21</code></a> docs: update to postcss-nesting</li>
<li><a href="https://github.com/nuxt-community/tailwindcss-module/commit/6240fdf331557f4b87a2580c545f3b49ce3faab5"><code>6240fdf</code></a> fix: use postcss-nesting instead</li>
<li><a href="https://github.com/nuxt-community/tailwindcss-module/commit/23adb8de33f5756f684e8d9afbcc41530e81e244"><code>23adb8d</code></a> chore(release): 4.0.0</li>
<li><a href="https://github.com/nuxt-community/tailwindcss-module/commit/753c4dcc63869d1da490ef9ccf6eef55fb4c951c"><code>753c4dc</code></a> chore: remove dev branch</li>
<li><a href="https://github.com/nuxt-community/tailwindcss-module/commit/93036c3fb27d1bb17f0cf60de78f0ece66b91c44"><code>93036c3</code></a> chore: upgrade tailwind jit</li>
<li><a href="https://github.com/nuxt-community/tailwindcss-module/commit/15a86a9628f9fb941ebe8a6eba62f3b6ab579b04"><code>15a86a9</code></a> feat!: v4 (<a href="https://github.com/nuxt-community/tailwindcss-module/issues/287">#287</a>)</li>
<li><a href="https://github.com/nuxt-community/tailwindcss-module/commit/a133848da91d6b366105101a8a882989ba0d52c3"><code>a133848</code></a> docs: update configPath documentation (<a href="https://github.com/nuxt-community/tailwindcss-module/issues/290">#290</a>)</li>
<li>See full diff in <a href="https://github.com/nuxt-community/tailwindcss-module/compare/v3.4.3...v4.0.1">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=@nuxtjs/tailwindcss&package-manager=npm_and_yarn&previous-version=3.4.3&new-version=4.0.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants