Skip to content

Commit 4f556c9

Browse files
sserrataclaude
sserrata
and
claude
authored
docs: correct categoryLinkSource supported values (#1447)
* docs: correct categoryLinkSource supported values (#1229) Remove the unsupported `none` value, document `auto`, and correct the description of `tag` to reflect the current `doc`-type link behavior. Note that omitting the option produces the implicit "no link config" behavior that `none` previously denoted (PR #495). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * docs: sync categoryLinkSource table in demo intro.mdx Apply the same correction to the demo site's options table so the hosted docs match the package READMEs. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 16f7c9c commit 4f556c9

3 files changed

Lines changed: 17 additions & 17 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -183,14 +183,14 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
183183

184184
`sidebarOptions` can be configured with the following options:
185185

186-
| Name | Type | Default | Description |
187-
| -------------------- | --------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
188-
| `groupPathsBy` | `string` | `null` | Organize and group sidebar slice by specified option. Note: Currently, `groupPathsBy` only contains support for grouping by `tag` and `tagGroup`. |
189-
| `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. |
190-
| `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. |
191-
| `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. |
192-
| `customProps` | `object` | `null` | Additional props for customizing a sidebar item. |
193-
| `sidebarGenerators` | `object` | `null` | Optional: Customize sidebar rendering with callback functions. |
186+
| Name | Type | Default | Description |
187+
| -------------------- | --------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
188+
| `groupPathsBy` | `string` | `null` | Organize and group sidebar slice by specified option. Note: Currently, `groupPathsBy` only contains support for grouping by `tag` and `tagGroup`. |
189+
| `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 `doc` and uses the generated tag index page as the category link. <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/>`auto`: Sets the category link config type to `generated-index` and auto-generates an index page for each tag category. <br/><br/>When omitted, no link config is generated and categories render as expand/collapse groups only. |
190+
| `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. |
191+
| `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. |
192+
| `customProps` | `object` | `null` | Additional props for customizing a sidebar item. |
193+
| `sidebarGenerators` | `object` | `null` | Optional: Customize sidebar rendering with callback functions. |
194194

195195
> You may optionally configure a `sidebarOptions`. In doing so, an individual `sidebar.js` slice with the configured options will be generated within the respective `outputDir`.
196196
> Use `x-position` vendor extension (or the front matter `position`) on operations to explicitly order sidebar items.

‎demo/docs/intro.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
231231
| Name | Type | Default | Description |
232232
| -------------------- | --------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
233233
| `groupPathsBy` | `string` | `null` | Organize and group sidebar slice by specified option. Note: Currently, `groupPathsBy` only contains support for grouping by `tag` and `tagGroup`. |
234-
| `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. |
234+
| `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 `doc` and uses the generated tag index page as the category link. <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/>`auto`: Sets the category link config type to `generated-index` and auto-generates an index page for each tag category. <br/><br/>When omitted, no link config is generated and categories render as expand/collapse groups only. |
235235
| `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. |
236236
| `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. |
237237
| `customProps` | `object` | `null` | Additional props for customizing a sidebar item. |

0 commit comments

Comments
 (0)