1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
---
layout: ~/layouts/MainLayout.astro
title: Configuration Reference
---
To configure Astro, add an `astro.config.mjs` file to the root of your project.
```js
export default /** @type {import('astro').AstroUserConfig} */ ({
// all options are optional; these values are the defaults
projectRoot: './',
public: './public/',
dist: './dist/',
src: './src/',
pages: './src/pages/',
renderers: [
'@astrojs/renderer-svelte',
'@astrojs/renderer-vue',
'@astrojs/renderer-react',
'@astrojs/renderer-preact',
],
buildOptions: {
site: 'https://my-site.dev/',
sitemap: true,
pageUrlFormat: 'directory',
drafts: false,
},
devOptions: {
hostname: 'localhost',
port: 3000,
trailingSlash: 'always',
},
vite: {},
markdownOptions: {},
});
```
#### projectRoot
The `projectRoot` option sets the working directory used by Astro. Astro will resolve all other directory options from this path.
**Default**: The current working directory.
#### public
The `public` option sets the directory used to resolve public assets. Astro does not process any files within this directory.
**Default**: The `public` directory within the `projectRoot` directory.
#### dist
The `dist` option sets the directory used to output the final build of the project. Contents of the `public` directory are also copied into this directory.
**Default**: The `dist` directory within the `projectRoot` directory.
#### src
The `src` option sets the directory used to resolve source files, like `pages`. Astro may process, optimize, and bundle any files in this directory.
**Default**: The `src` directory within the `projectRoot` directory.
#### pages
The `pages` option sets the directory used to resolve pages, relative to the `projectRoot` option.
**Default**: The `src/pages` directory within the `projectRoot` directory.
#### renderers
The `renderers` option defines the framework renderers to be used by Astro.
**Default**: An array of `@astrojs/renderer-svelte`, `@astrojs/renderer-vue`, `@astrojs/renderer-react`, and `@astrojs/renderer-preact`. To assign no renderers at all, you must provide an empty array (`[]`).
#### buildOptions
The `buildOptions` option configures how a site is built, including its base URL (`buildOptions.site`), whether it includes a sitemap (`buildOptions.sitemap`), whether markdown draft pages should be included in the build (`buildOptions.drafts`), and whether its pages should be files (`path.html`) or directories (`path/index.html`) (`buildOptions.pageUrlFormat`).
**Defaults**:
- `buildOptions.site`: Public [origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin) used to generate sitemaps and canonical URLs.
- Your public domain, e.g.: `https://my-site.dev/`.
- `buildOptions.sitemap`: Whether to automatically generate a sitemap.
- Either `true` or `false`.
- Default: `true`.
- `buildOptions.pageUrlFormat`: Determines how files built from pages are written.
- Either `file` (ex: "/foo.html") or `directory` (ex: "/foo/index.html").
- Default: `'directory'`.
- `buildOptions.drafts`: Determines whether markdown draft pages are included in the build.
- Either `true` or `false`.
- Default: `false`.
Read more about [markdown draft pages][markdown-draft-pages].
#### devOptions
The `devOptions` option configures features used during development, including the server hostname (`devOptions.hostname`), the server port (`devOptions.port`), and whether urls should include a trailing slash (`devOptions.trailingSlash`).
**Defaults**:
- `devOptions.hostname`: The hostname for the dev server.
- Default: `localhost`.
- `devOptions.port`: The port to run the dev server on.
- Default: `3000`.
- `devOptions.trailingSlash`: Trailing slash behavior of URL route matching.
- Either `always` (ex: "/foo/"), `never` (ex: "/foo"), or `ignore` (regardless of trailing "/").
- Default: `'always'`.
#### vite
The `vite` option configures the internals of Vite. These options can be explored on [ViteJS.dev](https://vitejs.dev/config/).
#### markdownOptions
The `markdownOptions` option assigns options to the Markdown parser. These options can be explored on [GitHub](https://github.com/withastro/astro/blob/latest/packages/astro/src/@types/astro.ts).
---
You can view the entire configuration API on [GitHub](https://github.com/withastro/astro/blob/latest/packages/astro/src/@types/astro.ts).
[markdown-draft-pages]: /en/guides/markdown-content#markdown-draft-pages
|
