summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Sarah Rainsberger <sarah@rainsberger.ca> 2024-06-26 12:39:06 -0300
committerGravatar GitHub <noreply@github.com> 2024-06-26 12:39:06 -0300
commit9176cf135bc1d9d1a343b8fb6d6423d66df1b725 (patch)
tree5dbaff2fa296aceeabde366bf1a44bd2a7910b87
parent84be17fdf6e403ac705cef696eca2735e0ad09c5 (diff)
downloadastro-9176cf135bc1d9d1a343b8fb6d6423d66df1b725.tar.gz
astro-9176cf135bc1d9d1a343b8fb6d6423d66df1b725.tar.zst
astro-9176cf135bc1d9d1a343b8fb6d6423d66df1b725.zip
[docs] update compressHTML entry for readability (#11345)
Diffstat (limited to '')
-rw-r--r--packages/astro/src/@types/astro.ts10
1 files changed, 6 insertions, 4 deletions
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts
index 46490dfa8..3668aa9de 100644
--- a/packages/astro/src/@types/astro.ts
+++ b/packages/astro/src/@types/astro.ts
@@ -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
* {