added note on importance of site_url #7103
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this was in response to squidfunk#4678 (comment)
squidfunk
requested changes
Apr 26, 2024
docs/creating-your-site.md
Outdated
| @@ -44,6 +44,22 @@ theme: | |||
| name: material | |||
| ``` | |||
|
|
|||
| Note that by default, MkDocs will assume that your site is hosted at the root of | |||
There was a problem hiding this comment.
Great work! We should add that the site_url setting is strongly recommended from our perspective, as without it, several features will not work, including instant loading and previews, as well as social cards.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this was in response to
#4678 (comment)