Skip to content

categoryLinkSource does not accept none Β #933

@wolstad

Description

@wolstad

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions