diff options
Diffstat (limited to 'docs/config.md')
-rw-r--r-- | docs/config.md | 40 |
1 files changed, 15 insertions, 25 deletions
diff --git a/docs/config.md b/docs/config.md index 7474109cc..dbbe311a2 100644 --- a/docs/config.md +++ b/docs/config.md @@ -4,34 +4,24 @@ To configure Astro, add an `astro.config.mjs` file in the root of your project. ```js export default { - /** Where to resolve all URLs relative to. Useful if you have a monorepo project. */ - projectRoot: '.', - /** Path to your site’s pages (routes) */ - pages: './src/pages', - /** When running `astro build`, path to final static output */ - dist: './dist', - /** A folder of static files Astro will copy to the root. Useful for favicons, images, and other files that don’t need processing. */ - public: './public', - /** Extension-specific handlings */ - extensions: { - /** Set this to "preact" or "react" to determine what *.jsx files should load */ - '.jsx': 'react', - }, - /** Options specific to `astro build` */ + 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 don’t need processing. buildOptions: { - /** Your public domain, e.g.: https://my-site.dev/. Used to generate sitemaps and canonical URLs. */ - site: '', - /** Generate sitemap (set to "false" to disable) */ - sitemap: true, + // 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) }, - /** Options for the development server run with `astro dev`. */ devOptions: { - /** The port to run the dev server on. */ - port: 3000, - /** Path to tailwind.config.js if used, e.g. './tailwind.config.js' */ - tailwindConfig: undefined, + port: 3000, // The port to run the dev server on. + // tailwindConfig: '', // Path to tailwind.config.js if used, e.g. './tailwind.config.js' }, - /** default array of rendering packages inserted into runtime */ - renderers: ['@astrojs/renderer-preact', '@astrojs/renderer-react', '@astrojs/renderer-svelte', '@astrojs/renderer-vue'], + // component renderers which are enabled by default + renderers: [ + '@astrojs/renderer-svelte', + '@astrojs/renderer-vue', + '@astrojs/renderer-react', + '@astrojs/renderer-preact' + ], }; ``` |