0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
astro/docs/config.md

28 lines
1.2 KiB
Markdown
Raw Normal View History

# ⚙️ Configuration
To configure Astro, add an `astro.config.mjs` file in the root of your project. All settings are optional. Here are the defaults:
```js
export default {
projectRoot: '.', // Where to resolve all URLs relative to. Useful if you have a monorepo project.
pages: './src/pages', // Path to Astro components, pages, and data
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 dont 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'
},
// component renderers which are enabled by default
renderers: [
'@astrojs/renderer-svelte',
'@astrojs/renderer-vue',
'@astrojs/renderer-react',
'@astrojs/renderer-preact'
],
};
```