Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update config base type description #4954

Merged
merged 1 commit into from
Oct 4, 2022
Merged

Update config base type description #4954

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion packages/astro/src/@types/astro.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,12 +421,21 @@ export interface AstroUserConfig {
* @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`.
*
*
* ```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;

Expand Down