From b3941526cb738d476ec05e29b9aadfd33f4d572b Mon Sep 17 00:00:00 2001 From: Joep Meindertsma Date: Tue, 23 Aug 2022 10:33:25 +0200 Subject: [PATCH] Explain how to use `site-url` Make sure people use the right kind of asset-urls. This issue only shows up when deploying, not using `mdbook serve`. --- guide/src/format/configuration/renderers.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/guide/src/format/configuration/renderers.md b/guide/src/format/configuration/renderers.md index f1d5ee15..b9c30861 100644 --- a/guide/src/format/configuration/renderers.md +++ b/guide/src/format/configuration/renderers.md @@ -157,7 +157,8 @@ The following configuration options are available: Defaults to `404.md`. - **site-url:** The url where the book will be hosted. This is required to ensure navigation links and script/css imports in the 404 file work correctly, even when accessing - urls in subdirectories. Defaults to `/`. + urls in subdirectories. Defaults to `/`. If `site-url` is set, + make sure to use document relative links for your assets, meaning they should not start with `/`. - **cname:** The DNS subdomain or apex domain at which your book will be hosted. This string will be written to a file named CNAME in the root of your site, as required by GitHub Pages (see [*Managing a custom domain for your GitHub Pages