astro/docs/reference/configuration-reference.md

30 lines
1.5 KiB
Markdown
Raw Normal View History

2021-06-28 06:27:12 +00:00
---
layout: ~/layouts/Main.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:
```js
export default {
2021-06-02 16:36:44 +00:00
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
2021-06-02 16:36:44 +00:00
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.
2021-06-02 16:36:44 +00:00
sitemap: true, // Generate sitemap (set to "false" to disable)
},
devOptions: {
2021-06-02 16:36:44 +00:00
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
2021-06-02 16:36:44 +00:00
renderers: ['@astrojs/renderer-svelte', '@astrojs/renderer-vue', '@astrojs/renderer-react', '@astrojs/renderer-preact'],
};
```
2021-06-28 06:27:12 +00:00
## Snowpack Config
Astro is powered internally by Snowpack. You can configure Snowpack directly by creating a `snowpack.config.js` file. See [snowpack.dev](https://www.snowpack.dev/reference/configuration) for full documentation on this file.