Skip to content

fix: use tailwind.config.mjs file by default config #903

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
Oct 26, 2023
Merged

fix: use tailwind.config.mjs file by default config #903

merged 13 commits into from
Oct 26, 2023

Conversation

torn4dom4n
Copy link
Contributor

What kind of changes does this PR include?

  • Changes Starlight docs site content

Description

Since Astro v3.2.4, the @astrojs/tailwind integration now creates a tailwind.config.mjs file by default with PR withastro/astro#8638. So this content should be changed.

I'm participating in Hacktoberfest

@changeset-bot
Copy link

changeset-bot bot commented Oct 14, 2023 •
edited
Loading

🦋 Changeset detected

Latest commit: d51c9f9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@astrojs/starlight-tailwind Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@netlify
Copy link

netlify bot commented Oct 14, 2023 •
edited
Loading

👷 Deploy Preview for astro-starlight processing.

Name Link
🔨 Latest commit d51c9f9
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/653abfc3ff53240008edd5d6

@github-actions github-actions bot added the 📚 docs Documentation website changes label Oct 14, 2023
@torn4dom4n torn4dom4n changed the title docs: @astrojs/tailwind use tailwind.config.mjs file by default docs: update guide for tailwind css Oct 14, 2023
HiDeoo
HiDeoo reviewed Oct 14, 2023
View reviewed changes
Copy link
Member

@HiDeoo HiDeoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution 🙌

Some potential thoughts/questions I had while checking out the PR:

Also, docs-only changes do not require a changeset, and even if we end up updating the Starlight Tailwind Starter Kit, I'm not sure if that would require a changeset either.

@delucis
Copy link
Member

delucis commented Oct 14, 2023

Thanks for picking this up @torn4dom4n!

I think all of @HiDeoo’s suggestions here are good ones, and I can confirm we don’t need a changeset for these changes. If we update the JSDoc in the Tailwind plugin though, then we would want a patch changeset for the Tailwind package so that update gets released.

@github-actions github-actions bot added the 🌟 tailwind Changes to Starlight’s Tailwind package label Oct 15, 2023
@torn4dom4n torn4dom4n changed the title docs: update guide for tailwind css fix: use tailwind.config.mjs file by default config Oct 15, 2023
@torn4dom4n
Copy link
Contributor Author

Thank you @HiDeoo, I follow your suggestions. Happy to contribute to this awesome repo.

@torn4dom4n torn4dom4n requested a review from HiDeoo October 15, 2023 02:24
HiDeoo
HiDeoo reviewed Oct 15, 2023
View reviewed changes
Copy link
Member

@HiDeoo HiDeoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks for the update. I guess we also want to switch from require to import too?

Note: there is also one require in the docs/src/components/theme-designer.astro file that I cannot suggest change for it.

torn4dom4n and others added 6 commits October 15, 2023 21:35
@torn4dom4n @HiDeoo
cjs to mjs
9592c1f 
Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>
@torn4dom4n @HiDeoo
cjs to mjs
dc2e926 
Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>
@torn4dom4n @HiDeoo
cjs to mjs
df245eb 
Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>
@torn4dom4n @HiDeoo
cjs to mjs
5c624e7 
Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>
@torn4dom4n
Merge branch 'main' into setup-tailwind
d578b12
@torn4dom4n
cjs to mjs
f6075a7
@torn4dom4n
Copy link
Contributor Author

@HiDeoo I used require in my tailwind's config 😄 and it worked so I forgot to update these files. I committed to GitHub with your suggestions. Please review it.

HiDeoo
HiDeoo approved these changes Oct 15, 2023
View reviewed changes
Copy link
Member

@HiDeoo HiDeoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes 🙌

Yeah, I tried it too and was not expecting for it to work ^^ (but I guess it makes sense considering they're using jiti under the hood).

Personally, I think this looks great and everything is covered. Let's see if others have any comments.

delucis
delucis reviewed Oct 26, 2023
View reviewed changes
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me! Just suggesting a small tweak to clarify the changeset.

torn4dom4n and others added 2 commits October 27, 2023 02:36
@torn4dom4n @delucis
Update .changeset/thick-bats-pay.md
2efb007 
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
@torn4dom4n
Merge branch 'main' into setup-tailwind
d51c9f9
@delucis delucis added the hacktoberfest-accepted Mark a PR as accepted to contribute towards Hacktoberfest label Oct 26, 2023
delucis
delucis approved these changes Oct 26, 2023
View reviewed changes
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again @torn4dom4n! LGTM 🚀

@delucis delucis merged commit 232f512 into withastro:main Oct 26, 2023
@astrobot-houston astrobot-houston mentioned this pull request Oct 26, 2023
Merged
@HiDeoo HiDeoo mentioned this pull request Oct 27, 2023
Merged
vasfvitor added a commit to vasfvitor/astro-starlight that referenced this pull request Nov 1, 2023
@vasfvitor
update - css-and-tailwind.mdx - withastro#903
d08c660
@morinokami morinokami mentioned this pull request Dec 2, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@delucis delucis delucis approved these changes

@HiDeoo HiDeoo HiDeoo approved these changes

Assignees
No one assigned
Labels
📚 docs Documentation website changes hacktoberfest-accepted Mark a PR as accepted to contribute towards Hacktoberfest 🌟 tailwind Changes to Starlight’s Tailwind package
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@torn4dom4n @delucis @HiDeoo