astro 7.2.2 → 7.2.3

package/dist/types/public/config.d.ts

@@ -82,11 +82,14 @@ export type ServerConfig = {
      * hostname is allowed.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   server: {
-     *   	allowedHosts: ['staging.example.com', 'qa.example.com']
+     *     allowedHosts: ['staging.example.com', 'qa.example.com']
      *   }
-     * }
+     * });
      * ```
      */
     allowedHosts?: string[] | true;
@@ -110,9 +113,12 @@ export type ServerConfig = {
      * Pass a full URL string (e.g. "http://example.com") or a pathname (e.g. "/about") to specify the URL to open.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   server: { open: "/about" }
-     * }
+     * });
      * ```
      */
     open?: string | boolean;
@@ -140,9 +146,12 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * Your final, deployed URL. Astro uses this full URL to generate your sitemap and canonical URLs in your final build. It is strongly recommended that you set this configuration to get the most out of Astro.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   site: 'https://www.my-site.dev'
-     * }
+     * });
      * ```
      */
     site?: string;
@@ -156,9 +165,12 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * In the example below, `astro dev` will start your server at `/docs`.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   base: '/docs'
-     * }
+     * });
      * ```
      *
      * When using this option, all of your static asset imports and URLs should add the base as a prefix. You can access this value via `import.meta.env.BASE_URL`.
@@ -171,19 +183,25 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      *
      * In the example below, the values of `import.meta.env.BASE_URL` and `config.base` when processed will both be `/docs`:
      * ```js
-     * {
-     * 	 base: '/docs/',
-     * 	 trailingSlash: "never"
-     * }
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
+     *   base: '/docs/',
+     *   trailingSlash: "never"
+     * });
      * ```
      *
      * In the example below, the values of `import.meta.env.BASE_URL` and `config.base` when processed will both be `/docs/`:
      *
      * ```js
-     * {
-     * 	 base: '/docs',
-     * 	 trailingSlash: "always"
-     * }
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
+     *   base: '/docs',
+     *   trailingSlash: "always"
+     * });
      * ```
      */
     base?: string;
@@ -206,10 +224,13 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * See your hosting platform's documentation for more information. You cannot use Astro [redirects](https://docs.astro.build/en/reference/configuration-reference/#redirects) for this use case at this point.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   // Example: Require a trailing slash during development
      *   trailingSlash: 'always'
-     * }
+     * });
      * ```
      */
     trailingSlash?: 'always' | 'never' | 'ignore';
@@ -219,7 +240,8 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * @type {Record<string, RedirectConfig>}
      * @default `{}`
      * @version 2.9.0
-     * @description Specify a mapping of redirects where the key is the route to match
+     * @description
+     * Specify a mapping of redirects where the key is the route to match
      * and the value is the path to redirect to.
      *
      * You can redirect both static and dynamic routes, but only to the same kind of route.
@@ -227,6 +249,9 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      *
      *
      * ```js
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
      * export default defineConfig({
      *   redirects: {
      *    '/old': '/new',
@@ -237,8 +262,8 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      *      destination: 'https://example.com/news'
      *    },
      *    // '/product1/', '/product1' // Note, this is not supported
-     * 	}
-     * })
+     *   }
+     * });
      * ```
      *
      *
@@ -252,6 +277,9 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * You can customize the [redirection status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#redirection_messages) using an object in the redirect config:
      *
      * ```js
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
      * export default defineConfig({
      *   redirects: {
      *     '/other': {
@@ -259,9 +287,7 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      *       destination: '/place',
      *     },
      *   }
-     * })
-     *
-     *
+     * });
      * ```
      */
     redirects?: Record<string, RedirectConfig>;
@@ -279,11 +305,12 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * - `'server'` - Use server-side rendering (SSR) for all pages by default, always outputting a server-rendered site.
      *
      * ```js
+     * // astro.config.mjs
      * import { defineConfig } from 'astro/config';
      *
      * export default defineConfig({
      *   output: 'static'
-     * })
+     * });
      * ```
      */
     output?: 'static' | 'server';
@@ -299,11 +326,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * See our [on-demand rendering guide](https://docs.astro.build/en/guides/on-demand-rendering/) for more on Astro's server rendering options.
      *
      * ```js
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
      * import netlify from '@astrojs/netlify';
-     * {
+     *
+     * export default defineConfig({
      *   // Example: Build for Netlify serverless deployment
      *   adapter: netlify(),
-     * }
+     * });
      * ```
      */
     adapter?: AstroIntegration;
@@ -318,12 +348,15 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * Read our [Integrations Guide](https://docs.astro.build/en/guides/integrations/) for help getting started with Astro Integrations.
      *
      * ```js
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
      * import react from '@astrojs/react';
      * import mdx from '@astrojs/mdx';
-     * {
+     *
+     * export default defineConfig({
      *   // Example: Add React + MDX support to Astro
      *   integrations: [react(), mdx()]
-     * }
+     * });
      * ```
      */
     integrations?: Array<AstroIntegration | (AstroIntegration | false | undefined | null)[] | false | undefined | null>;
@@ -334,19 +367,24 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * @type {string}
      * @default `"."` (current working directory)
      * @summary Set the project root. The project root is the directory where your Astro project (and all `src`, `public` and `package.json` files) live.
-     * @description  You should only provide this option if you run the `astro` CLI commands in a directory other than the project root directory. Usually, this option is provided via the CLI instead of the Astro config file, since Astro needs to know your project root before it can locate your config file.
+     * @description
+     * You should only provide this option if you run the `astro` CLI commands in a directory other than the project root directory. Usually, this option is provided via the CLI instead of the Astro config file, since Astro needs to know your project root before it can locate your config file.
      *
      * If you provide a relative path (ex: `--root: './my-project'`) Astro will resolve it against your current working directory.
      *
-     * #### Examples
-     *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   root: './my-project-directory'
-     * }
+     * });
      * ```
+     *
+     * The following example sets the root directory using the CLI:
+     *
      * ```bash
-     * $ astro build --root ./my-project-directory
+     * astro build --root ./my-project-directory
      * ```
      */
     root?: string;
@@ -355,14 +393,18 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * @name srcDir
      * @type {string}
      * @default `"./src"`
-     * @description Set the directory that Astro will read your site from.
+     * @description
+     * Set the directory that Astro will read your site from.
      *
      * The value can be either an absolute file system path or a path relative to the project root.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   srcDir: './www'
-     * }
+     * });
      * ```
      */
     srcDir?: string;
@@ -377,9 +419,12 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * The value can be either an absolute file system path or a path relative to the project root.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   publicDir: './my-custom-publicDir-directory'
-     * }
+     * });
      * ```
      */
     publicDir?: string;
@@ -389,14 +434,18 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * @type {string}
      * @default `"./dist"`
      * @see build.server
-     * @description Set the directory that `astro build` writes your final build to.
+     * @description
+     * Set the directory that `astro build` writes your final build to.
      *
      * The value can be either an absolute file system path or a path relative to the project root.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   outDir: './my-custom-build-directory'
-     * }
+     * });
      * ```
      */
     outDir?: string;
@@ -405,14 +454,18 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * @name cacheDir
      * @type {string}
      * @default `"./node_modules/.astro"`
-     * @description Set the directory for caching build artifacts. Files in this directory will be used in subsequent builds to speed up the build time.
+     * @description
+     * Set the directory for caching build artifacts. Files in this directory will be used in subsequent builds to speed up the build time.
      *
      * The value can be either an absolute file system path or a path relative to the project root.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   cacheDir: './my-custom-cache-directory'
-     * }
+     * });
      * ```
      */
     cacheDir?: string;
@@ -432,11 +485,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * Setting this option to `false` disables HTML compression and preserves all whitespace.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   compressHTML: true
      *   // or:
      *   // compressHTML: false
-     * }
+     * });
      * ```
      */
     compressHTML?: boolean | 'jsx';
@@ -471,9 +527,12 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * - `ignore`: silently build using the highest-priority route when conflicts occur
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   prerenderConflictBehavior: 'error'
-     * }
+     * });
      * ```
      */
     prerenderConflictBehavior?: 'error' | 'warn' | 'ignore';
@@ -490,23 +549,29 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * #### Examples
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   vite: {
      *     ssr: {
      *       // Example: Force a broken package to skip SSR processing, if needed
      *       external: ['broken-npm-package'],
      *     }
      *   }
-     * }
+     * });
      * ```
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   vite: {
      *     // Example: Add custom vite plugins directly to your Astro project
      *     plugins: [myPlugin()],
      *   }
-     * }
+     * });
      * ```
      */
     vite?: ViteUserConfig;
@@ -528,12 +593,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      *
      * ```js
      * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
      * export default defineConfig({
      *   output: "server",
      *   security: {
      *     checkOrigin: false
      *   }
-     * })
+     * });
      * ```
      */
     security?: {
@@ -575,7 +642,10 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * - `**.example.com` - matches any subdomain depth (e.g., both `sub.example.com` and `deep.sub.example.com`)
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   security: {
          *     // Example: Allow any subdomain of example.com on https
          *     allowedDomains: [
@@ -590,18 +660,21 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *       }
          *     ]
          *   }
-         * }
+         * });
          * ```
          *
          * In some specific contexts (e.g., applications behind trusted reverse proxies with dynamic domains), you may need to allow all domains. To do this, use an empty object:
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   security: {
          *     // Allow any domain - use this only when necessary
          *     allowedDomains: [{}]
          *   }
-         * }
+         * });
          * ```
          *
          * When not configured, `X-Forwarded-Host` headers are not trusted and will be ignored.
@@ -623,11 +696,13 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *
          * ```js
          * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
          * export default defineConfig({
          *   security: {
          *     actionBodySizeLimit: 10 * 1024 * 1024 // 10 MB
          *   }
-         * })
+         * });
          * ```
          */
         actionBodySizeLimit?: number;
@@ -647,11 +722,13 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *
          * ```js
          * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
          * export default defineConfig({
          *   security: {
          *     serverIslandBodySizeLimit: 10 * 1024 * 1024 // 10 MB
          *   }
-         * })
+         * });
          * ```
          */
         serverIslandBodySizeLimit?: number;
@@ -1157,12 +1234,15 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *   - `'preserve'`: Astro will generate HTML files exactly as they appear in your source folder. (e.g. `src/pages/about.astro` builds `/about.html` and `src/pages/about/index.astro` builds the file `/about/index.html`)
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   build: {
          *     // Example: Generate `page.html` instead of `page/index.html` during build.
          *     format: 'file'
          *   }
-         * }
+         * });
          * ```
          *
          *
@@ -1192,12 +1272,15 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * This value is relative to the `outDir`.
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   output: 'server',
          *   build: {
          *     client: './client'
          *   }
-         * }
+         * });
          * ```
          */
         client?: string;
@@ -1212,11 +1295,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * This value is relative to the `outDir`.
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   build: {
          *     server: './server'
          *   }
-         * }
+         * });
          * ```
          */
         server?: string;
@@ -1231,11 +1317,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * Specifies the directory in the build output where Astro-generated assets (bundled JS and CSS for example) should live.
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   build: {
          *     assets: '_custom'
          *   }
-         * }
+         * });
          * ```
          */
         assets?: string;
@@ -1254,11 +1343,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * To fetch all assets uploaded to the same domain (e.g. `https://cdn.example.com/_astro/...`), set `assetsPrefix` to the root domain as a string (regardless of your `base` configuration):
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   build: {
          *     assetsPrefix: 'https://cdn.example.com'
          *   }
-         * }
+         * });
          * ```
          *
          * **Added in:** `astro@4.5.0`
@@ -1267,7 +1359,10 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * In this case, a `fallback` property is required and will be used by default for any other files.
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   build: {
          *     assetsPrefix: {
          *       'js': 'https://js.cdn.example.com',
@@ -1276,7 +1371,7 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *       'fallback': 'https://cdn.example.com'
          *     }
          *   }
-         * }
+         * });
          * ```
          *
          */
@@ -1295,11 +1390,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * detects that the file is a JavaScript module.
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   build: {
          *     serverEntry: 'main.mjs'
          *   }
-         * }
+         * });
          * ```
          */
         serverEntry?: string;
@@ -1318,11 +1416,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * configuration files for redirects and do not need/want HTML based redirects.
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   build: {
          *     redirects: false
          *   }
-         * }
+         * });
          * ```
          */
         redirects?: boolean;
@@ -1339,11 +1440,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *  - `'never'` - project styles are sent in external stylesheets
          *
          * ```js
-         * {
-         * 	build: {
-         *		inlineStylesheets: `never`,
-         * 	},
-         * }
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
+         *   build: {
+         *     inlineStylesheets: `never`,
+         *   },
+         * });
          * ```
          */
         inlineStylesheets?: 'always' | 'auto' | 'never';
@@ -1362,11 +1466,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * If the number is set too high, page rendering may slow down due to insufficient memory resources and because JS is single-threaded.
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   build: {
          *     concurrency: 2
          *   }
-         * }
+         * });
          * ```
          *
          *  :::caution[Breaking changes possible]
@@ -1384,20 +1491,29 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * Customize the Astro dev server, used by both `astro dev` and `astro preview`.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   server: { port: 1234, host: true}
-     * }
+     * });
      * ```
      *
      * To set different configuration based on the command run ("dev", "preview") a function can also be passed to this configuration option.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   // Example: Use the function syntax to customize based on command
      *   server: ({ command }) => ({ port: command === 'dev' ? 4321 : 4000 })
-     * }
+     * });
      * ```
      */
+    server?: ServerConfig | ((options: {
+        command: 'dev' | 'preview';
+    }) => ServerConfig);
     /**
      * @docs
      * @name server.host
@@ -1421,9 +1537,12 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * If the given port is already in use, Astro will automatically try the next available port.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   server: { port: 8080 }
-     * }
+     * });
      * ```
      */
     /**
@@ -1438,11 +1557,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * hostname is allowed.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   server: {
-     *   	allowedHosts: ['staging.example.com', 'qa.example.com']
+     *     allowedHosts: ['staging.example.com', 'qa.example.com']
      *   }
-     * }
+     * });
      * ```
      */
     /**
@@ -1457,9 +1579,12 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * Pass a full URL string (e.g. "http://example.com") or a pathname (e.g. "/about") to specify the URL to open.
      *
      * ```js
-     * {
+     * // astro.config.mjs
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
      *   server: { open: "/about" }
-     * }
+     * });
      * ```
      */
     /**
@@ -1471,9 +1596,6 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * @description
      * Set custom HTTP response headers to be sent in `astro dev` and `astro preview`.
      */
-    server?: ServerConfig | ((options: {
-        command: 'dev' | 'preview';
-    }) => ServerConfig);
     /**
      * @docs
      * @kind heading
@@ -1632,13 +1754,13 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * import vercel from '@astrojs/vercel'
      *
      * export default defineConfig({
-     *   adapter: vercel()
+     *   adapter: vercel(),
      *   session: {
      *     driver: sessionDrivers.redis({
      *       url: process.env.REDIS_URL
      *     }),
      *   }
-     * })
+     * });
      * ```
      *
      * :::note
@@ -1660,15 +1782,17 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * The driver-specific options to use for session storage. The options depend on the driver you are using. See the [Unstorage documentation](https://unstorage.unjs.io/drivers)
      * for more information on the options available for each driver.
      *
-     * ```js title="astro.config.mjs" ins={4-6}
-     * {
-     *    session: {
-     *      driver: "redis",
-     *      options: {
-     *        url: process.env.REDIS_URL
-     *      },
-     *    }
-     * }
+     * ```js title="astro.config.mjs" ins={6-8}
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
+     *   session: {
+     *     driver: "redis",
+     *     options: {
+     *       url: process.env.REDIS_URL
+     *     },
+     *   }
+     * });
      * ```
      */
     /**
@@ -1682,27 +1806,30 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * The session cookie configuration. If set to a string, it will be used as the cookie name.
      * Alternatively, you can pass an object with additional options. These will be merged with the defaults.
      *
-     * ```js title="astro.config.mjs" ins={3-4}
-     * {
-     *  session: {
-     *    // If set to a string, it will be used as the cookie name.
-     *    cookie: "my-session-cookie",
-     *  }
-     * }
+     * ```js title="astro.config.mjs" ins={5-6}
+     * import { defineConfig } from 'astro/config';
      *
+     * export default defineConfig({
+     *   session: {
+     *     // If set to a string, it will be used as the cookie name.
+     *     cookie: "my-session-cookie",
+     *   }
+     * });
      * ```
      *
-     * ```js title="astro.config.mjs" ins={4-8}
-     * {
-     *  session: {
-     *    // If set to an object, it will be used as the cookie options.
-     *    cookie: {
-     *      name: "my-session-cookie",
-     *      sameSite: "lax",
-     *      secure: true,
-     *    }
-     *  }
-     * }
+     * ```js title="astro.config.mjs" ins={5-10}
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
+     *   session: {
+     *     // If set to an object, it will be used as the cookie options.
+     *     cookie: {
+     *       name: "my-session-cookie",
+     *       sameSite: "lax",
+     *       secure: true,
+     *     }
+     *   }
+     * });
      * ```
      */
     /**
@@ -1719,13 +1846,15 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * Set `session.ttl` to add a default expiration period for your session values. Passing a `ttl` option to [`session.set()`](https://docs.astro.build/en/reference/api-reference/#sessionset) will override the global default
      * for that individual entry.
      *
-     * ```js title="astro.config.mjs" ins={3-4}
-     * {
-     *  session: {
-     *    // Set a default expiration period of 1 hour (3600 seconds)
-     *    ttl: 3600,
-     *  }
-     * }
+     * ```js title="astro.config.mjs" ins={5-6}
+     * import { defineConfig } from 'astro/config';
+     *
+     * export default defineConfig({
+     *   session: {
+     *     // Set a default expiration period of 1 hour (3600 seconds)
+     *     ttl: 3600,
+     *   }
+     * });
      * ```
      * :::note
      * Setting a value for `ttl` does not automatically delete the value from storage after the time limit has passed.
@@ -1795,9 +1924,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * This value defaults to `true` when using the `<ClientRouter />` router. Otherwise, the default value is `false`.
          *
          * ```js
-         * prefetch: {
-         * 	prefetchAll: true
-         * }
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
+         *   prefetch: {
+         *     prefetchAll: true,
+         *   },
+         * });
          * ```
          *
          * When set to `true`, you can disable prefetching individually by setting `data-astro-prefetch="false"` on any individual links.
@@ -1844,15 +1978,18 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * Set the endpoint to use for image optimization in dev and SSR. The `entrypoint` property can be set to `undefined` to use the default image endpoint.
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   image: {
          *     // Example: Use a custom image endpoint at `/custom_endpoint`
          *     endpoint: {
-         * 		 	route: '/custom_endpoint',
-         * 		 	entrypoint: 'src/my_endpoint.ts',
-         * 		},
+         *       route: '/custom_endpoint',
+         *       entrypoint: 'src/my_endpoint.ts',
+         *     },
          *   },
-         * }
+         * });
          * ```
          */
         endpoint?: {
@@ -1873,24 +2010,27 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * The service entrypoint can be either one of the included services, or a third-party package.
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   image: {
          *     // Example: Enable the Sharp-based image service with a custom config
          *     service: {
-         * 			 entrypoint: 'astro/assets/services/sharp',
-         * 			 config: {
-         * 				 limitInputPixels: false,
-         * 				 webp: {
-         * 					 effort: 6,
-         * 					 alphaQuality: 80,
-         * 				 },
-         * 				 jpeg: {
-         * 					 mozjpeg: true,
-         * 				 },
+         *       entrypoint: 'astro/assets/services/sharp',
+         *       config: {
+         *         limitInputPixels: false,
+         *         webp: {
+         *           effort: 6,
+         *           alphaQuality: 80,
+         *         },
+         *         jpeg: {
+         *           mozjpeg: true,
+         *         },
          *       },
-         * 		 },
+         *     },
          *   },
-         * }
+         * });
          * ```
          */
         service?: ImageServiceConfig;
@@ -2002,12 +2142,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *
          * ```js
          * // astro.config.mjs
-         * {
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   image: {
          *     // Example: Allow remote image optimization from a single domain
          *     domains: ['astro.build'],
          *   },
-         * }
+         * });
          * ```
          */
         domains?: string[];
@@ -2027,7 +2169,10 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * 4. pathname
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   image: {
          *     // Example: allow processing all images from your aws s3 bucket
          *     remotePatterns: [{
@@ -2035,7 +2180,7 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *       hostname: '**.amazonaws.com',
          *     }],
          *   },
-         * }
+         * });
          * ```
          *
          * You can use wildcards to define the permitted `hostname` and `pathname` values as described below. Otherwise, only the exact values provided will be configured.
@@ -2189,12 +2334,15 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * - `false` - do not apply syntax highlighting.
 
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   markdown: {
          *     // Example: Switch to use prism for syntax highlighting in Markdown
          *     syntaxHighlight: 'prism',
          *   }
-         * }
+         * });
          * ```
          *
          * For more control over syntax highlighting, you can instead specify a configuration object with the properties listed below.
@@ -2253,12 +2401,15 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * Pass [remark plugins](https://github.com/remarkjs/remark) to customize how your Markdown is built. You can import and apply the plugin function (recommended), or pass the plugin name as a string.
          *
          * ```js
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
          * import remarkToc from 'remark-toc';
-         * {
+         *
+         * export default defineConfig({
          *   markdown: {
          *     remarkPlugins: [ [remarkToc, { heading: "contents"} ] ]
          *   }
-         * }
+         * });
          * ```
          */
         remarkPlugins?: RemarkPlugins;
@@ -2273,12 +2424,15 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * Pass [rehype plugins](https://github.com/remarkjs/remark-rehype) to customize how your Markdown's output HTML is processed. You can import and apply the plugin function (recommended), or pass the plugin name as a string.
          *
          * ```js
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
          * import { rehypeAccessibleEmojis } from 'rehype-accessible-emojis';
-         * {
+         *
+         * export default defineConfig({
          *   markdown: {
          *     rehypePlugins: [rehypeAccessibleEmojis]
          *   }
-         * }
+         * });
          * ```
          */
         rehypePlugins?: RehypePlugins;
@@ -2295,11 +2449,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * Astro uses [GitHub-flavored Markdown](https://github.com/remarkjs/remark-gfm) by default. To disable this, set the `gfm` flag to `false`:
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   markdown: {
          *     gfm: false,
          *   }
-         * }
+         * });
          * ```
          */
         gfm?: boolean;
@@ -2333,12 +2490,15 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * Pass options to [remark-rehype](https://github.com/remarkjs/remark-rehype#api).
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   markdown: {
          *     // Example: Translate the footnotes text to another language, here are the default English values
          *     remarkRehype: { footnoteLabel: "Footnotes", footnoteBackLabel: "Back to reference 1"},
          *   },
-         * };
+         * });
          * ```
          */
         remarkRehype?: RemarkRehype;
@@ -2442,16 +2602,19 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * The following example configures your content fallback strategy to redirect unavailable pages in `/pt-br/` to their `es` version, and unavailable pages in `/fr/` to their `en` version. Unavailable `/es/` pages will return a 404.
          *
          * ```js
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
          * export default defineConfig({
-         * 	i18n: {
-         * 		defaultLocale: "en",
-         * 		locales: ["en", "fr", "pt-br", "es"],
-         * 		fallback: {
-         * 			pt: "es",
-         * 		  fr: "en"
-         * 		}
-         * 	}
-         * })
+         *   i18n: {
+         *     defaultLocale: "en",
+         *     locales: ["en", "fr", "pt-br", "es"],
+         *     fallback: {
+         *       "pt-br": "es",
+         *       fr: "en"
+         *     }
+         *   }
+         * });
          * ```
          */
         fallback?: [TLocales] extends [never] ? Record<string, string> : {
@@ -2468,29 +2631,35 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * Controls the routing strategy to determine your site URLs. Set this based on your folder/URL path configuration for your default language.
          *
          * ```js
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
          * export default defineConfig({
-         * 	i18n: {
-         * 		defaultLocale: "en",
-         * 		locales: ["en", "fr"],
-         * 		routing: {
-         * 			prefixDefaultLocale: false,
-         * 			redirectToDefaultLocale: true,
-         * 			fallbackType: "redirect",
-         * 		}
-         * 	}
-         * })
+         *   i18n: {
+         *     defaultLocale: "en",
+         *     locales: ["en", "fr"],
+         *     routing: {
+         *       prefixDefaultLocale: false,
+         *       redirectToDefaultLocale: true,
+         *       fallbackType: "redirect",
+         *     }
+         *   }
+         * });
          * ```
          *
          * Since 4.6.0, this option can also be set to `manual`. When this routing strategy is enabled, Astro will **disable** its i18n middleware and no other `routing` options (e.g. `prefixDefaultLocale`) may be configured. You will be responsible for writing your own routing logic, or executing Astro's i18n middleware manually alongside your own.
          *
          * ```js
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
          * export default defineConfig({
-         * 	i18n: {
-         * 		defaultLocale: "en",
-         * 		locales: ["en", "fr"],
-         * 		routing: "manual"
-         * 	}
-         * })
+         *   i18n: {
+         *     defaultLocale: "en",
+         *     locales: ["en", "fr"],
+         *     routing: "manual"
+         *   }
+         * });
          * ```
          *
          */
@@ -2513,15 +2682,18 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
              * Localized folders are used for every language, including the default.
              *
              * ```js
+             * // astro.config.mjs
+             * import { defineConfig } from 'astro/config';
+             *
              * export default defineConfig({
-             * 	i18n: {
-             * 		defaultLocale: "en",
-             * 		locales: ["en", "fr", "pt-br", "es"],
-             * 		routing: {
-             * 			prefixDefaultLocale: true,
-             * 		}
-             * 	}
-             * })
+             *   i18n: {
+             *     defaultLocale: "en",
+             *     locales: ["en", "fr", "pt-br", "es"],
+             *     routing: {
+             *       prefixDefaultLocale: true,
+             *     }
+             *   }
+             * });
              * ```
              */
             prefixDefaultLocale?: boolean;
@@ -2540,17 +2712,19 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
              * Set `redirectToDefaultLocale: true` to enable this automatic redirection at the root of your site:
              * ```js
              * // astro.config.mjs
+             * import { defineConfig } from 'astro/config';
+             *
              * export default defineConfig({
              *   i18n:{
              *     defaultLocale: "en",
-             * 		locales: ["en", "fr"],
+             *     locales: ["en", "fr"],
              *     routing: {
              *       prefixDefaultLocale: true,
              *       redirectToDefaultLocale: true
              *     }
              *   }
-             * })
-             *```
+             * });
+             * ```
              * */
             redirectToDefaultLocale?: boolean;
             /**
@@ -2573,19 +2747,21 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
              *
              * ```js
              * //astro.config.mjs
+             * import { defineConfig } from 'astro/config';
+             *
              * export default defineConfig({
-             * 	 i18n: {
+             *   i18n: {
              *     defaultLocale: "en",
              *     locales: ["en", "fr"],
              *     routing: {
-             *     	prefixDefaultLocale: false,
-             *     	fallbackType: "rewrite",
+             *       prefixDefaultLocale: false,
+             *       fallbackType: "rewrite",
              *     },
              *     fallback: {
-             *     	fr: "en",
+             *       fr: "en",
              *     }
              *   },
-             * })
+             * });
              * ```
              */
             fallbackType?: 'redirect' | 'rewrite';
@@ -2608,21 +2784,23 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * ```js
          * //astro.config.mjs
          * export default defineConfig({
-         * 	 site: "https://example.com",
-         * 	 output: "server", // required, with no prerendered pages
-         * 	 adapter: node({
-         * 	   mode: 'standalone',
-         * 	 }),
-         * 	 i18n: {
+         *   site: "https://example.com",
+         *   output: "server", // required, with no prerendered pages
+         *   adapter: node({
+         *     mode: 'standalone',
+         *   }),
+         *   i18n: {
          *     defaultLocale: "en",
          *     locales: ["en", "fr", "pt-br", "es"],
-         *     prefixDefaultLocale: false,
+         *     routing: {
+         *       prefixDefaultLocale: false,
+         *     },
          *     domains: {
          *       fr: "https://fr.example.com",
          *       es: "https://example.es"
          *     }
          *   },
-         * })
+         * });
          * ```
          *
          * Both page routes built and URLs returned by the `astro:i18n` helper functions [`getAbsoluteLocaleUrl()`](https://docs.astro.build/en/reference/modules/astro-i18n/#getabsolutelocaleurl) and [`getAbsoluteLocaleUrlList()`](https://docs.astro.build/en/reference/modules/astro-i18n/#getabsolutelocaleurllist) will use the options set in `i18n.domains`.
@@ -2669,7 +2847,7 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *       API_SECRET: envField.string({ context: "server", access: "secret" }),
          *     }
          *   }
-         * })
+         * });
          * ```
          */
         schema?: EnvSchema;
@@ -2696,7 +2874,7 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *     },
          *     validateSecrets: true
          *   }
-         * })
+         * });
          * ```
          */
         validateSecrets?: boolean;
@@ -2713,6 +2891,9 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      *
      * See our guide for more information on [using custom fonts in Astro](https://docs.astro.build/en/guides/fonts/).
      */
+    fonts?: [TFontProviders] extends [never] ? Array<FontFamily> : {
+        [K in keyof TFontProviders]: FontFamily<TFontProviders[K]>;
+    };
     /**
      * @docs
      * @name font.provider
@@ -2722,6 +2903,7 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * The source of your font files. You can use a [built-in provider](https://docs.astro.build/en/reference/font-provider-reference/#built-in-providers) or write your own [custom provider](https://docs.astro.build/en/reference/font-provider-reference/#building-a-font-provider):
      *
      * ```js
+     * // astro.config.mjs
      * import { defineConfig, fontProviders } from "astro/config";
      *
      * export default defineConfig({
@@ -2932,9 +3114,6 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      * variationSettings: "'xhgt' 0.7"
      * ```
      */
-    fonts?: [TFontProviders] extends [never] ? Array<FontFamily> : {
-        [K in keyof TFontProviders]: FontFamily<TFontProviders[K]>;
-    };
     /**
      * @docs
      * @kind heading
@@ -2950,16 +3129,16 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      *
      * ```js
      * // astro.config.mjs
-     * import { memoryCache } from 'astro/config';
+     * import { defineConfig, memoryCache } from 'astro/config';
      *
-     * {
+     * export default defineConfig({
      *   cache: {
      *     provider: memoryCache(),
      *   },
      *   routeRules: {
      *     '/blog/[...path]': { maxAge: 300, swr: 60 },
      *   },
-     * }
+     * });
      * ```
      *
      * Use `Astro.cache.set()` in routes and `context.cache.set()` in middleware
@@ -2978,6 +3157,7 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * Use the provider's config function to get type-safe configuration:
          *
          * ```js
+         * // astro.config.mjs
          * import { defineConfig, memoryCache } from 'astro/config';
          *
          * export default defineConfig({
@@ -3002,15 +3182,15 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
      *
      * ```js
      * // astro.config.mjs
-     * import { memoryCache } from 'astro/config';
+     * import { defineConfig, memoryCache } from 'astro/config';
      *
-     * {
+     * export default defineConfig({
      *   cache: { provider: memoryCache() },
      *   routeRules: {
      *     '/api/[...path]': { swr: 600 },
      *     '/products/[...slug]': { maxAge: 3600, tags: ['products'] },
      *   },
-     * }
+     * });
      * ```
      */
     routeRules?: RouteRules;
@@ -3067,15 +3247,17 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *
          * ```js
          * // astro.config.mjs
-         * {
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   prefetch: {
          *     prefetchAll: true,
          *     defaultStrategy: 'viewport',
          *   },
-         * 	experimental: {
-         * 		clientPrerender: true,
-         * 	},
-         * }
+         *   experimental: {
+         *     clientPrerender: true,
+         *   },
+         * });
          * ```
          *
          * Continue to use the `data-astro-prefetch` attribute on any `<a />` link on your site to opt in to prefetching.
@@ -3099,11 +3281,14 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * When enabled, this feature will generate and add JSON schemas to the `.astro` directory in your project. These files can be used by the Astro language server to provide Intellisense inside content files (`.md`, `.mdx`, `.mdoc`).
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   experimental: {
          *     contentIntellisense: true,
          *   },
-         * }
+         * });
          * ```
          *
          * To use this feature with the Astro VS Code extension, you must also enable the `astro.content-intellisense` option in your VS Code settings. For editors using the Astro language server directly, pass the `contentIntellisense: true` initialization parameter to enable this feature.
@@ -3122,6 +3307,7 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * allowing you to edit files directly in the browser and have those changes reflected in your local file system.
          *
          * ```js
+         * // astro.config.mjs
          * import { defineConfig } from 'astro/config';
          *
          * export default defineConfig({
@@ -3146,12 +3332,15 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * and better performance while maintaining visual quality.
          *
          * ```js
-         * {
+         * // astro.config.mjs
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   experimental: {
          *     // Enable with defaults
          *     svgOptimizer: svgoOptimizer()
          *   }
-         * }
+         * });
          * ```
          *
          * See the [experimental SVG optimization docs](https://docs.astro.build/en/reference/experimental-flags/svg-optimization/) for more information.
@@ -3176,6 +3365,7 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          * is recommended for broad adapter compatibility.
          *
          * ```js
+         * // astro.config.mjs
          * import { defineConfig } from 'astro/config';
          *
          * export default defineConfig({
@@ -3213,11 +3403,13 @@ export interface AstroUserConfig<TLocales extends Locales = never, TDriver exten
          *
          * ```js
          * // astro.config.mjs
-         * {
+         * import { defineConfig } from 'astro/config';
+         *
+         * export default defineConfig({
          *   experimental: {
          *     incrementalBuild: true,
          *   },
-         * }
+         * });
          * ```
          *
          * In your dynamic routes, return a `cacheKey` from `getStaticPaths()`: