Skip to content

Commit

Permalink
added note on importance of site_url
Browse files Browse the repository at this point in the history
this was in response to
squidfunk#4678 (comment)
  • Loading branch information
alexvoss committed Apr 26, 2024
1 parent 222d9e1 commit 0f886b8
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/creating-your-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,22 @@ theme:
name: material
```
Note that by default, MkDocs will assume that your site is hosted at the root of
your domain. If that is not the case then you also need to add a `site_url`
setting:

``` yaml hl_lines="1"
site_url: https://www.example.com/mysite
theme:
name: material
```

For example, the `site_url` needs to be set in order to [publish to GitHub
pages] - unless you use GitHub pages with a custom domain.

[publish to GitHub pages]: publishing-your-site.md#github-pages


[installation methods]: getting-started.md#installation

???+ tip "Recommended: [configuration validation and auto-complete]"
Expand Down

0 comments on commit 0f886b8

Please sign in to comment.