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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add nested property to SidebarOptions #1058

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

Maschga
Copy link

@Maschga Maschga commented Dec 27, 2024

Hi, 👋
First of all: Thank you very much for this plugin!

Description

I added a nested-property to the SidebarOptions-interface.

Motivation and Context

I use this plugin to document a Rest-API with OpenAPI. However, I use the auto-generate feature of Docusaurus to generate the sidebars since this documentation is toooooo big to add the sidebar-items manually. Therefore, I was not able to use the groupPathsBy-option. Because I couldn't find a workaround, but I really wanted to group the endpoints by their tag, I decided to implement the feature.

How Has This Been Tested?

I imported these changes locally in evcc-io/docs#698 and deployed them successfully and without errors. I was able to build and serve the project.

Types of changes

  • New feature (non-breaking change which adds functionality)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

Thank you very much in advance!
~Maschga

@Maschga
Copy link
Author

Maschga commented Dec 28, 2024

I'm not able to fix this test even though the changes work as expected. Can somebody help me, please?

@Maschga Maschga marked this pull request as ready for review January 3, 2025 17:10
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.

1 participant