-
Notifications
You must be signed in to change notification settings - Fork 211
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
[Experimental ] Add sidebarOptions
with groupByTags
support
#53
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 tasks
…usaurus-openapi into add-sidebar-options
Size Change: -437 kB (-19%) 👏 Total Size: 1.88 MB
ℹ️ View Unchanged
|
Visit the preview URL for this PR (updated for commit b3f743d): https://docusaurus-openapi-36b86--pr53-vxmqumwq.web.app (expires Fri, 20 May 2022 00:04:07 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR introduces the concept of
sidebarOptions
to thedocusaurus-plugin-openapi
plugin. The intent is thatsidebarOptions
can be used when greater flexibility is required when generating sidebars for OpenAPI docs. For example, withsidebarOptions
, you can generate asidebar.js
slice with paths grouped by tag, which is a common use case in our environment.Example usage:
Motivation and Context
Autogenerated sidebars doesn't have the ability to group OAS paths which limits our ability to organize large API specifications for easier reading.
How Has This Been Tested?
Screenshots (if appropriate)
Types of changes
Checklist