Skip to content

Small updates to tailwind template#3303

Merged
delucis merged 3 commits intowithastro:mainfrom
astrochemx:small-fixes-example-tailwind
Jul 15, 2025
Merged

Small updates to tailwind template#3303
delucis merged 3 commits intowithastro:mainfrom
astrochemx:small-fixes-example-tailwind

Conversation

@astrochemx
Copy link
Copy Markdown
Contributor

@astrochemx astrochemx commented Jul 15, 2025

Description

This PR updates the Starlight Tailwind template to address several issues:

  • updates README.md

    • revises the Project Structure - removes tailwind.config.mjs and adds styles/global.css

    • adds a note about customizing included Tailwind CSS styles:

      The project includes Tailwind CSS for styling. Customize your design by modifying src/styles/global.css.

  • fixes a typo in Example Reference: what your documenting --> what you're documenting

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Jul 15, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: e937b51

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@netlify
Copy link
Copy Markdown

netlify bot commented Jul 15, 2025 •
edited
Loading

✅ Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit e937b51
🔍 Latest deploy log https://app.netlify.com/projects/astro-starlight/deploys/6876d95a43485d0008395f81
😎 Deploy Preview https://deploy-preview-3303--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@astrobot-houston
Copy link
Copy Markdown
Contributor

astrobot-houston commented Jul 15, 2025

Hello! Thank you for opening your first PR to Starlight! ✨

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any issues you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🤩

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@astrochemx astrochemx changed the title Small updates to Starlight Tailwind template docs: small updates to tailwind template Jul 15, 2025
@astrochemx astrochemx changed the title docs: small updates to tailwind template Small updates to tailwind template Jul 15, 2025
delucis
delucis reviewed Jul 15, 2025
View reviewed changes
Copy link
Copy Markdown
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.

Ah, great catch — thanks for the updates @astrochemx! Suggested one tiny detail that I think can be improved but otherwise this looks great 🌟

examples/tailwind/README.md Outdated
│ ├── content/
│ │ ├── docs/
│ ├── styles/
│ │ ├── global.css
Copy link
Copy Markdown
Member

@delucis delucis Jul 15, 2025

Choose a reason for hiding this comment

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

Tiny detail here fixing the box style:

Suggested change
│ │ ├── global.css
│ │ └── global.css

Copy link
Copy Markdown
Contributor Author

@astrochemx astrochemx Jul 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks, @delucis ! Should we also do the same with docs?

Copy link
Copy Markdown
Member

@delucis delucis Jul 15, 2025

Choose a reason for hiding this comment

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

Oh, yes! I was focused on your changes, but you're absolutely right that this should be fixed there too.

Copy link
Copy Markdown
Contributor Author

@astrochemx astrochemx Jul 15, 2025

Choose a reason for hiding this comment

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

Done! 😄

@astrochemx astrochemx force-pushed the small-fixes-example-tailwind branch from 4818e7d to e937b51 Compare July 15, 2025 22:42
delucis
delucis approved these changes Jul 15, 2025
View reviewed changes
Copy link
Copy Markdown
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.

Thank you for the carefully put together PR @astrochemx — appreciate it!

@delucis delucis merged commit 2e36bcf into withastro:main Jul 15, 2025
14 checks passed
HiDeoo added a commit to shubham-padia/starlight that referenced this pull request Jul 16, 2025
@HiDeoo
Merge branch 'main' into support-custom-icons
f817a91 
* main:
  Small updates to `tailwind` template (withastro#3303)
  docs: showcase `astro-d2` and "Starlight Plugins by Example" (withastro#3302)
  [ci] release (withastro#3301)
  Fix `absolutePathToLang()` issue (withastro#3298)
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

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@astrochemx @astrobot-houston @delucis