michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix docs on config api

Browse source
This commit is contained in:
Fred K. Schott 2021-08-23 14:16:29 -07:00
parent 69272dc8d1
commit 2538325a46
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/src/pages/reference/configuration-reference.md
View file

@ -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