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

Correct base documentation (#4992)

Browse source
This commit is contained in:
Dan Jutan 2022-10-07 16:50:25 -04:00 committed by GitHub
parent 145e2c575a
commit f93449b80f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 10 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,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;