Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
Code Issues Activity

[docs] update build.format with note an adapter may set this value (#9502)

Browse source
This commit is contained in:
Sarah Rainsberger 2023-12-22 16:15:19 -04:00 committed by GitHub
parent 05d923db53
commit b20cab1404
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -722,7 +722,7 @@ export interface AstroUserConfig {
* @typeraw {('file' | 'directory')} * @typeraw {('file' | 'directory')}
* @default `'directory'` * @default `'directory'`
* @description * @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 `'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. * - 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 * #### Effect on Astro.url
* Setting `build.format` controls what `Astro.url` is set to during the build. When it is: * 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/`. * - `directory` - The `Astro.url.pathname` will include a trailing slash to mimic folder behavior; ie `/foo/`.