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

categoryLinkSource does not accept none #933

Open
wolstad opened this issue Aug 26, 2024 · 0 comments
Open

categoryLinkSource does not accept none #933

wolstad opened this issue Aug 26, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@wolstad
Copy link

wolstad commented Aug 26, 2024

Documentation link

| `categoryLinkSource` | `string` | `null` | Defines what source to use for rendering category link pages when grouping paths by tag. <br/><br/>The supported options are as follows: <br/><br/> `tag`: Sets the category link config type to `generated-index` and uses the tag description as the link config description. <br/><br/>`info`: Sets the category link config type to `doc` and renders the `info` section as the category link (recommended only for multi/micro-spec scenarios). <br/><br/>`none`: Does not create pages for categories, only groups that can be expanded/collapsed. |

Describe the problem

The documentation indicates categoryLinkSource supports a none option, however, the plugin only accepts [tag, info, auto]

[ValidationError]: "config.api.sidebarOptions.categoryLinkSource" must be one of [tag, info, auto]

Suggested fix

Can we confirm if this functionality is no longer supported, and if so, remove this from the documentation?

If this option is no longer available, I would love to see this as a feature request. I am trying to remove category index page links from my sidebar and this would have been a huge help.

@wolstad wolstad added the documentation Improvements or additions to documentation label Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants
@wolstad and others