Skip to content

Commit 13f53eb

Browse files
authored
Merge pull request #1876 from joepio/patch-1
Explain how to use `site-url` with asset URLs
2 parents fff067b + b394152 commit 13f53eb

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

guide/src/format/configuration/renderers.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,8 @@ The following configuration options are available:
157157
Defaults to `404.md`.
158158
- **site-url:** The url where the book will be hosted. This is required to ensure
159159
navigation links and script/css imports in the 404 file work correctly, even when accessing
160-
urls in subdirectories. Defaults to `/`.
160+
urls in subdirectories. Defaults to `/`. If `site-url` is set,
161+
make sure to use document relative links for your assets, meaning they should not start with `/`.
161162
- **cname:** The DNS subdomain or apex domain at which your book will be hosted.
162163
This string will be written to a file named CNAME in the root of your site, as
163164
required by GitHub Pages (see [*Managing a custom domain for your GitHub Pages

0 commit comments

Comments
 (0)