diff options
| -rw-r--r-- | docs/src/pages/reference/configuration-reference.md | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/docs/src/pages/reference/configuration-reference.md b/docs/src/pages/reference/configuration-reference.md index e4591f7c4..7ec4176a0 100644 --- a/docs/src/pages/reference/configuration-reference.md +++ b/docs/src/pages/reference/configuration-reference.md @@ -5,17 +5,21 @@ title: Configuration Reference To configure Astro, add an `astro.config.mjs` file in the root of your project. All settings are optional. -You can view the full configuration API (including information about default configuration) on GitHub: https://github.com/snowpackjs/astro/blob/latest/packages/astro/src/@types/config.ts +You can view the full configuration API (including information about default configuration) on [GitHub.](https://github.com/snowpackjs/astro/blob/latest/packages/astro/src/@types/config.ts) ```js // Example: astro.config.mjs -/** @type {import('astro').AstroUserConfig} */ -export default { - buildOptions: { - site: 'https://example.com', - }, -}; +// @type-check enabled! +// VSCode and other TypeScript-enabled text editors will provide auto-completion, +// helpful tooltips, and warnings if your exported object is invalid. +// You can disable this by removing "@ts-check" and `@type` comments below. + +// @ts-check +export default /** @type {import('astro').AstroUserConfig} */ ({ + // ... +}); + ``` ## Snowpack Config |