diff options
author | 2022-10-07 16:50:25 -0400 | |
---|---|---|
committer | 2022-10-07 22:50:25 +0200 | |
commit | f93449b80f27e9057d40fe2b90b96c07730c9337 (patch) | |
tree | c12aaf8d4f5393675b6c30d8cc56a208789acd56 | |
parent | 145e2c575acadf124476bd826376af0b1058a33b (diff) | |
download | astro-f93449b80f27e9057d40fe2b90b96c07730c9337.tar.gz astro-f93449b80f27e9057d40fe2b90b96c07730c9337.tar.zst astro-f93449b80f27e9057d40fe2b90b96c07730c9337.zip |
Correct `base` documentation (#4992)
-rw-r--r-- | packages/astro/src/@types/astro.ts | 11 |
1 files changed, 1 insertions, 10 deletions
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index 908c93342..bbc5419f4 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -420,22 +420,13 @@ export interface AstroUserConfig { * @name base * @type {string} * @description - * The base path you're deploying to. Astro will match this pathname during development so that your development experience matches your build environment as closely as possible. In the example below, `astro dev` will start your server at `/docs`. + * The base path to deploy to. Astro will build your pages and assets using this path as the root. Currently, this has no effect during development. * * ```js * { * base: '/docs' * } * ``` - * - * When using this option, you should mind that all of your imports will be affected. In this example, all of the imports including static resources and codes should add a prefix `/docs/`. - * - * For example, if you want to use a image in your Astro component, you need to change it from '/someimg.png' into '/docs/someimg.png'. - * - * ```astro - * <!-- <img src="/someimg.png"> is not correct. --> - * <img src="/docs/someimg.png"> - * ``` */ base?: string; |