Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-01-13 22:11:20 -05:00
Code Issues Activity

[docs] update compressHTML entry for readability (#11345)

Browse source
This commit is contained in:
Sarah Rainsberger 2024-06-26 12:39:06 -03:00 • committed by GitHub
parent 84be17fdf6
commit 9176cf135b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
packages/astro/src/@types/astro.ts
View file

@ -751,10 +751,12 @@ export interface AstroUserConfig {
* @default `true`
* @description
*
* This is an option to minify your HTML output and reduce the size of your HTML files, occuring both in development mode and in the final build.
* By default, Astro removes whitespace from your HTML, including line breaks, from .astro components in a lossless manner.
* It is important to note that some whitespace may be kept to preserve the visual rendering of your HTML.
* To disable HTML compression, set the compressHTML flag to false.
* This is an option to minify your HTML output and reduce the size of your HTML files.
*
* By default, Astro removes whitespace from your HTML, including line breaks, from `.astro` components in a lossless manner.
* Some whitespace may be kept as needed to preserve the visual rendering of your HTML. This occurs both in development mode and in the final build.
*
* To disable HTML compression, set `compressHTML` to false.
*
* ```js
* {