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.
What is the purpose of this pull request?
Overview of changes:
Hides the site nav section under a button on the navbar, making it easy to show/hide the site nav section when necessary.
The site nav section might not be needed at all times, especially within long, full-of-text pages.
Therefore, hiding the site nav section would give more display space to the contents of the site's pages.
Before:
After (hidden):
After (shown):
Anything you'd like to highlight / discuss:
This change is implemented as a MarkBind plugin, allowing for easier enabling/disabling of the enhancement through the
plugins
property ofsite.json
. The plugin is enabled by default.The show/hide site nav button adopts the theme of the site's navbar. Examples of this are shown below:
This change is open for further development (e.g., changing the position of the show/hide button).
Testing instructions:
For new MarkBind instances, initialize and serve such instances. The changes should appear automatically.
For existing MarkBind instances...
plugins
property exists, add"hiddenSiteNav"
to theplugins
array.pluginsContext
property exists, add the following to thepluginsContext
object:Note: the
dark
value fornavbarTheme
acts as a placeholder.plugins
norpluginsContext
exist, add the following to thesite.json
object:Proposed commit message: (wrap lines at 72 characters)
Checklist: ☑️