diff options
| author |  Matthew Phillips <matthew@skypack.dev>
| 2023-08-14 11:10:37 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-08-14 11:10:37 -0400 |
| commit | 4477bb41c8ed688785c545731ef5b184b629f4e5 (patch) | |
| tree | e09e668d5afc8d9ec2da71c0c3f8b48a887fb92d | |
| parent | 5208a3c8fefcec7694857fb344af351f4631fc34 (diff) | |
| download | astro-4477bb41c8ed688785c545731ef5b184b629f4e5.tar.gz astro-4477bb41c8ed688785c545731ef5b184b629f4e5.tar.zst astro-4477bb41c8ed688785c545731ef5b184b629f4e5.zip | |
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>
| -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 * } * ``` */ |