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`.
This commit is contained in:
parent
fff067b2a8
commit
b3941526cb
|
@ -157,7 +157,8 @@ The following configuration options are available:
|
||||||
Defaults to `404.md`.
|
Defaults to `404.md`.
|
||||||
- **site-url:** The url where the book will be hosted. This is required to ensure
|
- **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
|
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.
|
- **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
|
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
|
required by GitHub Pages (see [*Managing a custom domain for your GitHub Pages
|
||||||
|
|
Loading…
Reference in New Issue