From b20cab14047a84ec531481718dccea65582a38a0 Mon Sep 17 00:00:00 2001 From: Sarah Rainsberger Date: Fri, 22 Dec 2023 16:15:19 -0400 Subject: [PATCH] [docs] update build.format with note an adapter may set this value (#9502) --- packages/astro/src/@types/astro.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index 9df1b2bf12..e534145a61 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -722,7 +722,7 @@ export interface AstroUserConfig { * @typeraw {('file' | 'directory')} * @default `'directory'` * @description - * Control the output file format of each page. + * Control the output file format of each page. This value may be set by an adapter for you. * - If `'file'`, Astro will generate an HTML file (ex: "/foo.html") for each page. * - If `'directory'`, Astro will generate a directory with a nested `index.html` file (ex: "/foo/index.html") for each page. * @@ -735,6 +735,8 @@ export interface AstroUserConfig { * } * ``` * + * + * * #### Effect on Astro.url * Setting `build.format` controls what `Astro.url` is set to during the build. When it is: * - `directory` - The `Astro.url.pathname` will include a trailing slash to mimic folder behavior; ie `/foo/`.