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

Use directory-style path formatting with build.format: 'preserve' #1913

Merged
merged 2 commits into from
May 22, 2024

Conversation

delucis
Copy link
Member

@delucis delucis commented May 21, 2024

Description

  • Fixes Starlight is incompatible with the Astro build.format preserve option #1781
  • Astro v4.3 added the build: { format: 'preserve' } config option, which we haven’t been handling up until now.
  • I tested using this option and Starlight still produces files like guides/example/index.html for all its pages. Given this, it seemed safest to treat this the same way we treat build: { format: 'directory' } and render links as guides/example/.

Copy link

vercel bot commented May 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview May 21, 2024 3:37pm
1 Ignored Deployment
Name Status Preview Updated (UTC)
starlight-i18n ⬜️ Ignored (Inspect) May 21, 2024 3:37pm

Copy link

changeset-bot bot commented May 21, 2024

🦋 Changeset detected

Latest commit: 33df8c0

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 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

@github-actions github-actions bot added the 🌟 core Changes to Starlight’s main package label May 21, 2024
@astrobot-houston
Copy link
Collaborator

size-limit report 📦

Path Size
/index.html 5.26 KB (0%)
/_astro/*.js 21.81 KB (0%)
/_astro/*.css 13.79 KB (0%)

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.

To be perfectly honest, I don't think I've ever used preserve but from the docs, your explanations and the few tests I've done locally, I think the change makes sense to me 👍

@delucis
Copy link
Member Author

delucis commented May 22, 2024

Yeah. Maybe one day we should really have a Starlight linkFormat option or something, but as far as I can tell it makes no difference for injected routes like ours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌟 core Changes to Starlight’s main package 🌟 patch Change that triggers a patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Starlight is incompatible with the Astro build.format preserve option
3 participants