summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Félix Sanz <felixsanz@users.noreply.github.com> 2022-06-10 20:17:52 +0200
committerGravatar GitHub <noreply@github.com> 2022-06-10 13:17:52 -0500
commit6e8391365aa88e62f0de8d2e6aaf5ab59f77f087 (patch)
treeec5683dc4f31b32939f2da3fa47fdb6983e8eab4
parent098031294f4e25619d0ae5a6ffc871c7401d98ae (diff)
downloadastro-6e8391365aa88e62f0de8d2e6aaf5ab59f77f087.tar.gz
astro-6e8391365aa88e62f0de8d2e6aaf5ab59f77f087.tar.zst
astro-6e8391365aa88e62f0de8d2e6aaf5ab59f77f087.zip
Changed astro.config.js text to a link to the supported config file types (#3565)
Changed astro.config.js text to a link to the supported config file types, since above it appears astro.config.mjs and mixing extensions could lead to confusion (plus in that page linked we can see the valid extensions)
-rw-r--r--packages/astro/src/@types/astro.ts2
1 files changed, 1 insertions, 1 deletions
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts
index 45963dbcf..137fb3b85 100644
--- a/packages/astro/src/@types/astro.ts
+++ b/packages/astro/src/@types/astro.ts
@@ -277,7 +277,7 @@ export interface AstroUserConfig {
* @type {string}
* @default `"."` (current working directory)
* @summary Set the project root. The project root is the directory where your Astro project (and all `src`, `public` and `package.json` files) live.
- * @description You should only provide this option if you run the `astro` CLI commands in a directory other than the project root directory. Usually, this option is provided via the CLI instead of the `astro.config.js` file, since Astro needs to know your project root before it can locate your config file.
+ * @description You should only provide this option if you run the `astro` CLI commands in a directory other than the project root directory. Usually, this option is provided via the CLI instead of the [Astro config file](https://docs.astro.build/en/guides/configuring-astro/#supported-config-file-types), since Astro needs to know your project root before it can locate your config file.
*
* If you provide a relative path (ex: `--root: './my-project'`) Astro will resolve it against your current working directory.
*