Skip to content

Commit 4477bb4

Browse files
matthewpsarah11918
andauthored
Update types to specify that compress defaults to true (#8072)
* Update types to specify that compress defaults to true * Update astro.ts --------- Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
1 parent 5208a3c commit 4477bb4

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

.changeset/tasty-camels-speak.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'astro': patch
3+
---
4+
5+
Update Astro types to reflect that compress defaults to true

packages/astro/src/@types/astro.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -542,14 +542,14 @@ export interface AstroUserConfig {
542542
* @docs
543543
* @name compressHTML
544544
* @type {boolean}
545-
* @default `false`
545+
* @default `true`
546546
* @description
547-
* 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.
548-
* To enable this, set the `compressHTML` flag to `true`.
547+
* 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.
548+
* To disable HTML compression, set the `compressHTML` flag to `false`.
549549
*
550550
* ```js
551551
* {
552-
* compressHTML: true
552+
* compressHTML: false
553553
* }
554554
* ```
555555
*/

0 commit comments

Comments
 (0)