summaryrefslogtreecommitdiff
path: root/docs/src/pages/reference/configuration-reference.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src/pages/reference/configuration-reference.md')
-rw-r--r--docs/src/pages/reference/configuration-reference.md26
1 files changed, 7 insertions, 19 deletions
diff --git a/docs/src/pages/reference/configuration-reference.md b/docs/src/pages/reference/configuration-reference.md
index ef851f848..e4591f7c4 100644
--- a/docs/src/pages/reference/configuration-reference.md
+++ b/docs/src/pages/reference/configuration-reference.md
@@ -3,30 +3,18 @@ layout: ~/layouts/MainLayout.astro
title: Configuration Reference
---
-To configure Astro, add an `astro.config.mjs` file in the root of your project. All settings are optional. Here are the defaults:
+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
```js
+// Example: astro.config.mjs
+
+/** @type {import('astro').AstroUserConfig} */
export default {
- projectRoot: '.', // Where to resolve all URLs relative to. Useful if you have a monorepo project.
- src: './src', // Path to Astro components, pages, and data
- pages: './src/pages', // Path to Astro/Markdown pages
- dist: './dist', // When running `astro build`, path to final static output
- public: './public', // A folder of static files Astro will copy to the root. Useful for favicons, images, and other files that don't need processing.
buildOptions: {
- // site: '', // Your public domain, e.g.: https://my-site.dev/. Used to generate sitemaps and canonical URLs.
- sitemap: true, // Generate sitemap (set to "false" to disable)
- },
- devOptions: {
- port: 3000, // The port to run the dev server on.
- // tailwindConfig: '', // Path to tailwind.config.js if used, e.g. './tailwind.config.js'
+ site: 'https://example.com',
},
- // component renderers which are enabled by default
- renderers: [
- '@astrojs/renderer-svelte',
- '@astrojs/renderer-vue',
- '@astrojs/renderer-react',
- '@astrojs/renderer-preact',
- ],
};
```