Skip to content

Not clear how to disable navigation.instant for local pages #6105 #6116

Merged
squidfunk merged 1 commit intosquidfunk:masterfrom
alexvoss:offline
Oct 2, 2023
Merged

Not clear how to disable navigation.instant for local pages #6105 #6116
squidfunk merged 1 commit intosquidfunk:masterfrom
alexvoss:offline

Conversation

@alexvoss
Copy link
Copy Markdown
Collaborator

@alexvoss alexvoss commented Oct 2, 2023

I have added a note about building for offline usage and a link to the building for offline usage page.

That page could, in turn, do with an addition to show how the group plugin can be used to turn off functionality that will not work offline. I suggest developing this as an example. Happy to do it if you agree this is the right approach.

@squidfunk
Copy link
Copy Markdown
Owner

Thanks for the PR! I'm not sure this is the best location, because it's the basic getting up and running guide which you read when you first set up Material for MkDocs, and authors will likely dive deep into the setup, plugins, and reference section, forgetting about this. I think the offline guide is the best location for this, but we cannot cross reference the offline guide at each and every feature that does not work with it.

@alexvoss
Copy link
Copy Markdown
Collaborator Author

alexvoss commented Oct 2, 2023

I agree that people may forget about it but now at least it is there for those who consider an offline delivery format.

"we cannot cross reference the offline guide at each and every feature that does not work with it" - agreed. That is why I suggest strengthening the offline guide by showing how it is done there. People may still ask why plugin/feature X does not work but now we have a place to point them to. Could also be an example to avoid blowing up the documentation more. Do with the PR what you think is right. I thought that having the link to the building for offline page was useful to have.

@squidfunk
Copy link
Copy Markdown
Owner

Fair points. Let's add it and reconsider once we found a good way to better cluster our documentation into use cases ☺️

@squidfunk squidfunk merged commit f35a276 into squidfunk:master Oct 2, 2023
@alexvoss alexvoss deleted the offline branch October 2, 2023 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants