Skip to content

Improve docs for base url for public assets #4302

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve docs for base url for public assets #4302

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae58219
Improve docs for base url for public assets
everdimension Oct 22, 2024
b7eefab
reword
everdimension Oct 22, 2024
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
18 changes: 18 additions & 0 deletions docs/en/reference/site-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,24 @@ export default {
*/
```

If you're using [base](./site-config#base), the file will be available at `/your-base-url/favicon.ico`, but the rendered link tag will still point to `/favicon.icon`.
Currently, you have to handle this manually. Your site config needs to explicitly specify the base url:

```ts
export default {
head: [['link', { rel: 'icon', href: '/your-base-url/favicon.ico' }]]
}
```

If, for example, you don't know your base prefix ahead of time (for example, you're passing the `--base` option [during build](./cli#options-1)), one way to access it would be to also pass
it as an env variable and use it in the config file:

```ts
export default {
head: [['link', { rel: 'icon', href: `${process.env.BASE}/favicon.ico` }]]
}
```

#### Example: Adding Google Fonts

```ts
Expand Down