Skip to content

Document compressHTML: "jsx" config is only available since Astro 6.2.0#13920

Closed
LongYC wants to merge 1 commit into
withastro:mainfrom
LongYC:compresshtml-config-version-added
Closed

Document compressHTML: "jsx" config is only available since Astro 6.2.0#13920
LongYC wants to merge 1 commit into
withastro:mainfrom
LongYC:compresshtml-config-version-added

Conversation

@LongYC

@LongYC LongYC commented May 21, 2026

Copy link
Copy Markdown

Description (required)

Document on config reference page that compressHTML: "jsx" is only available starting Astro 6.2.0.

Without this reference, it looks like the option has always been available but users of older versions (e.g. 6.1.9) will see the following message that contradicts the documentation:

[config] Astro found issue(s) with your configuration:

! compressHTML: Expected type "boolean", received "string"

I tried to follow the writing style from i18n.routing which also introduced a new option, by starting the sentence similarly.

Related issues & labels (optional)

@netlify

netlify Bot commented May 21, 2026

Copy link
Copy Markdown

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 0674179
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/6a0f2f93b777fe0008e0d8fe
😎 Deploy Preview https://deploy-preview-13920--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@astrobot-houston

Copy link
Copy Markdown
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links 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.

@astrobot-houston

Copy link
Copy Markdown
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/reference/configuration-reference.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@ArmandPhilippot ArmandPhilippot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution! Yes, I think adding the version can be helpful. But, this file is read-only... as stated at the beginning of the file:

# NOTE: This file is auto-generated from 'scripts/docgen.mjs'
# Do not make edits to it directly, they will be overwritten.
# Instead, change this file: https://github.com/withastro/astro/blob/main/packages/astro/src/types/public/config.ts

To update the docs, you'll need to make a PR to withastro/astro to update the matching JSDoc in https://github.com/withastro/astro/blob/main/packages/astro/src/types/public/config.ts instead.

@LongYC

LongYC commented May 22, 2026

Copy link
Copy Markdown
Author

@ArmandPhilippot ops, my bad for failing to notice that, I ran into the error and thought I could do quick PR to update, let me close this and do a proper PR.

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.

3 participants