docs: add --livereload flag in Getting Started > Contributing > Documentation#381
Open
Aevarkan wants to merge 1 commit intoEndstoneMC:mainfrom
Open
docs: add --livereload flag in Getting Started > Contributing > Documentation#381Aevarkan wants to merge 1 commit intoEndstoneMC:mainfrom
--livereload flag in Getting Started > Contributing > Documentation#381Aevarkan wants to merge 1 commit intoEndstoneMC:mainfrom
Conversation
Contributor
Author
|
To update, I made a PR upstream, and using the |
Aevarkan
changed the title
--livereload flag in contributing to docs section--livereload flag in Getting Started > Contributing > Documentation section
Aevarkan
changed the title
--livereload flag in Getting Started > Contributing > Documentation section--livereload flag in Getting Started > Contributing > Documentation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I was wondering why using the
mkdocs servecommand wasn't actually updating the site live.The command instead needs to be run as
It turns out this is a bigger issue:
mkdocs servedoesn't reload upon change anymore squidfunk/mkdocs-material#8478mkdocs servefails to live reload mkdocs/mkdocs#4081I considered adding an explanation regarding the workaround in the documentation, but I don't think it's that big of an issue to leave it unmentioned. It's only adding a flag, and you'd figure out that not using the flag means the live preview stops working.
I believe it's a better idea to just not mention it, and anyone curious can have a look at this PR. Otherwise, don't inadvertently lead them down a rabbit hole.