Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update types to specify that compress defaults to true #8072

Merged
merged 2 commits into from
Aug 14, 2023
Merged

Update types to specify that compress defaults to true #8072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da03671
Update types to specify that compress defaults to true
matthewp Aug 14, 2023
48d6c0c
Update astro.ts
sarah11918 Aug 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tasty-camels-speak.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Update Astro types to reflect that compress defaults to true
8 changes: 4 additions & 4 deletions packages/astro/src/@types/astro.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
* }
* ```
*/
Expand Down