docusaurus-plugin-openapi-docs 0.0.0-832 → 0.0.0-834
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -12
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -172,17 +172,18 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
|
|
|
172
172
|
| `markdownGenerators` | `object` | `null` | _Optional:_ Customize MDX content with a set of options for specifying markdown generator functions. See below for a list of supported options. |
|
|
173
173
|
| `showSchemas` | `boolean` | `null` | _Optional:_ If set to `true`, generates schema pages and adds them to the sidebar. |
|
|
174
174
|
|
|
175
|
+
### sidebarOptions
|
|
176
|
+
|
|
175
177
|
`sidebarOptions` can be configured with the following options:
|
|
176
178
|
|
|
177
|
-
| Name | Type
|
|
178
|
-
| -------------------- |
|
|
179
|
-
| `groupPathsBy` | `string`
|
|
180
|
-
| `categoryLinkSource` | `string`
|
|
181
|
-
| `sidebarCollapsible` | `boolean`
|
|
182
|
-
| `sidebarCollapsed` | `boolean`
|
|
183
|
-
| `customProps` | `object`
|
|
184
|
-
| `sidebarGenerators` | `object`
|
|
185
|
-
| `createDocItem` | `function` | `null` | Optional: Returns a `SidebarItemDoc` object, which allows for customisation of sidebar items. For example, add a class name in certain conditions, or add `customProps` to provide custom rendering. See below for a list of supported operations. |
|
|
179
|
+
| Name | Type | Default | Description |
|
|
180
|
+
| -------------------- | --------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
181
|
+
| `groupPathsBy` | `string` | `null` | Organize and group sidebar slice by specified option. Note: Currently, `groupPathsBy` only contains support for grouping by `tag` and `tagGroup`. |
|
|
182
|
+
| `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. |
|
|
183
|
+
| `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. |
|
|
184
|
+
| `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. |
|
|
185
|
+
| `customProps` | `object` | `null` | Additional props for customizing a sidebar item. |
|
|
186
|
+
| `sidebarGenerators` | `object` | `null` | Optional: Customize sidebar rendering with callback functions. |
|
|
186
187
|
|
|
187
188
|
> 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`.
|
|
188
189
|
|
|
@@ -212,9 +213,9 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
|
|
|
212
213
|
|
|
213
214
|
`sidebarGenerators` can be configured with the following options:
|
|
214
215
|
|
|
215
|
-
| Name | Type | Default | Description
|
|
216
|
-
| --------------- | ---------- | ------- |
|
|
217
|
-
| `createDocItem` | `function` | `null` | Optional: Returns a `SidebarItemDoc` object containing metadata for a sidebar item.<br/><br/>**Function type
|
|
216
|
+
| Name | Type | Default | Description |
|
|
217
|
+
| --------------- | ---------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
218
|
+
| `createDocItem` | `function` | `null` | Optional: Returns a `SidebarItemDoc` object containing metadata for a sidebar item.<br/><br/>**Function type:** `(item: ApiPageMetadata \| SchemaPageMetadata, context: { sidebarOptions: SidebarOptions; basePath: string }) => SidebarItemDoc` |
|
|
218
219
|
|
|
219
220
|
## CLI Usage
|
|
220
221
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "docusaurus-plugin-openapi-docs",
|
|
3
3
|
"description": "OpenAPI plugin for Docusaurus.",
|
|
4
|
-
"version": "0.0.0-
|
|
4
|
+
"version": "0.0.0-834",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"openapi",
|
|
@@ -62,5 +62,5 @@
|
|
|
62
62
|
"engines": {
|
|
63
63
|
"node": ">=14"
|
|
64
64
|
},
|
|
65
|
-
"gitHead": "
|
|
65
|
+
"gitHead": "ae355505099a92c492cfe36546946b11b65af621"
|
|
66
66
|
}
|