diff options
| -rw-r--r-- | .changeset/tasty-camels-speak.md | 5 | ||||
| -rw-r--r-- | packages/astro/src/@types/astro.ts | 8 |
2 files changed, 9 insertions, 4 deletions
diff --git a/.changeset/tasty-camels-speak.md b/.changeset/tasty-camels-speak.md new file mode 100644 index 000000000..374163d9b --- /dev/null +++ b/.changeset/tasty-camels-speak.md @@ -0,0 +1,5 @@ +--- +'astro': patch +--- + +Update Astro types to reflect that compress defaults to true diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index 4867728b1..8bdd35173 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -542,14 +542,14 @@ export interface AstroUserConfig { * @docs * @name compressHTML * @type {boolean} - * @default `false` + * @default `true` * @description - * This is an option to minify your HTML output and reduce the size of your HTML files. When enabled, Astro removes all whitespace from your HTML, including line breaks, from `.astro` components. This occurs both in development mode and in the final build. - * To enable this, set the `compressHTML` flag to `true`. + * This is an option to minify your HTML output and reduce the size of your HTML files. By default, Astro removes all whitespace from your HTML, including line breaks, from `.astro` components. This occurs both in development mode and in the final build. + * To disable HTML compression, set the `compressHTML` flag to `false`. * * ```js * { - * compressHTML: true + * compressHTML: false * } * ``` */ |