Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add multi level section menu #617

Merged
merged 8 commits into from
Jan 26, 2022
Merged

feat: add multi level section menu #617

merged 8 commits into from
Jan 26, 2022

Conversation

h-enk
Copy link
Member

@h-enk h-enk commented Jan 18, 2022

Snag_7153c99

https://deploy-preview-617--doks.netlify.app/

This PR also implements the option to auto generate the menu from the directory-folder (tree) structure (no manual configuration needed, respects set weight, respects setting mainSections) 馃殌

New menu option setup in ./config/_default/params.toml:

[menu]
  [menu.section]
    auto = true
    collapsibleSidebar = true
    mainSections = ["docs", "tutorial"]

So, we get four multi level section menu options:

  • Auto generated collapsibile section menu
  • Auto generated default section menu
  • Manual configured collapsibile section menu
  • Manual configured default section menu

How to use /documentation will be available soon.

@h-enk h-enk linked an issue Jan 19, 2022 that may be closed by this pull request
@h-enk h-enk added the enhancement New feature or request label Jan 19, 2022
@james-d-elliott
Copy link
Contributor

james-d-elliott commented Jan 19, 2022

Looking really cool! Nice job! Only issue with it I can see is that.. I decided to start work on converting all my docs to doks, but now that this is coming I want to procrastinate! (just a joke obviously)

@h-enk
Copy link
Member Author

h-enk commented Jan 19, 2022

You could cherry pick 馃槈

Only this file really changed: ./layouts/partials/sidebar/docs-menu.html

@james-d-elliott
Copy link
Contributor

Yep, that's what I was planning on doing actually since we're forking and merging as necessary due to the significant changes we plan to do, I do really appreciate the information though, saves me figuring it out! I was mainly trying to express my excitement for this feature and my appreciation for your work.

@h-enk
Copy link
Member Author

h-enk commented Jan 20, 2022

I was mainly trying to express my excitement for this feature and my appreciation for your work.

Thanks for that!

How to /documentation will be available soon

@h-enk h-enk linked an issue Jan 20, 2022 that may be closed by this pull request
@h-enk h-enk merged commit 54d04d5 into master Jan 26, 2022
@h-enk h-enk deleted the section-menu branch January 26, 2022 14:02
adhadse pushed a commit to adhadse/doks that referenced this pull request Sep 17, 2022
feat: add multi level section menu
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sub Sub Menu Auto generated section menu
2 participants