feat: add support for build.format configuration#135
Merged
HiDeoo merged 4 commits intoHiDeoo:mainfrom Mar 10, 2026
Merged
Conversation
When build.format is set to file, links now correctly append .html instead of relying solely on trailing slash behavior. Renames getTrailingSlashTransformer to getLinkTransformer to reflect its broader responsibility. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
@nonoakij is attempting to deploy a commit to the HiDeoo's projects Team on Vercel. A member of the Team first needs to authorize it. |
🦋 Changeset detectedLatest commit: 5a34287 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
HiDeoo
approved these changes
Mar 10, 2026
Owner
HiDeoo
left a comment
HiDeoo
left a comment
There was a problem hiding this comment.
Thanks for your contribution 🙌
The change looks great to me. I slightly tweaked the code to make sure we use the same strategy that Starlight uses, e.g. when using preserve and adding a few helpers, but other than that, the logic is the same.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe the pull request
Add support for Astro's
build.formatconfiguration. Whenbuild.formatis set tofile, sidebar and operation links now correctly append.htmlsuffix. Also renamesgetTrailingSlashTransformertogetLinkTransformerto reflect its broader responsibility.Why
When using
build.format: 'file'in Astro config, other docs pages generate links with.htmlextension, but pages generated by starlight-openapi plugin still used the same link format asbuild.format: 'directory', resulting in inconsistent link behavior across the site.How
build.formatfrom Astro config throughStarlightOpenAPIContextvia the Vite plugingetTrailingSlashTransformertogetLinkTransformerand add a branch that appends.htmlwhenbuild.formatis notdirectory.htmlsuffix when comparing pathnames forisCurrentsidebar highlightingScreenshots
This screenshot shows the result of running
astro buildand thenastro previewafter specifyingbuild.format: 'file'indocs/astro.config.ts.