-
-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updates section navigation #92
Conversation
<nav {{ if eq site.Params.doks.menu.section.collapsibleSidebar false }}id="sidebar-default" {{ end }}class="docs-links" aria-label="Main navigation"> | ||
{{ partial "sidebar/docs-menu.html" . }} | ||
</nav> | ||
{{ partial "sidebar/section-menu.html" . }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe I don't have understand but this parameter is not used site.Params.doks.menu.section.collapsibleSidebar
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct. Now, when no sidebar_<section>
menu entries are found, Doks automatically generates a sidebar based on the filesystem structure of your documentation — no parameter needed. The new setup is a lot smarter and more robust.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand my issue better. This commit changes the design since it is no longer possible to have a menu without Before |
Yes, that's correct. So. if you'd like to keep the old design you could copy And, make sure to check/update for the old styling — add overrides in |
Or, you could override the new render method |
I don't want to deviate too much from Doks otherwise it will complicate the update. I especially wanted you to be aware if you hadn't seen the problem ;) |
I understand that — thanks |
Summary
Brief explanation of the proposed changes.
Sections are not collapsed (default), override per section in the frontmatter of the section's
_index.md
:Works with:
Basic example
Include a basic example, screenshots, or links.
Motivation
Why are we doing this? What use cases does it support? What is the expected outcome?
More robust, simplified, and powerful code with more features and easier expandability possibilities for for example badges, icons, and
target
attribute.Checks
npm run test