michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update config base type description (#4954)

Browse source
This commit is contained in:
Zihan Chen 2022-10-04 22:30:59 +08:00 committed by GitHub
parent c733d4fb81
commit 911c1d315c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
packages/astro/src/@types/astro.ts
View file

@ -420,12 +420,21 @@ export interface AstroUserConfig {
* @type {string} * @type {string}
* @description * @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 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`.
* *
* ```js * ```js
* { * {
* base: '/docs' * 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; base?: string;