docusaurus-plugin-openapi-docs 0.0.0-612 → 0.0.0-613
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 +25 -14
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -117,20 +117,21 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
|
|
|
117
117
|
|
|
118
118
|
`config` can be configured with the following options:
|
|
119
119
|
|
|
120
|
-
| Name
|
|
121
|
-
|
|
|
122
|
-
| `specPath`
|
|
123
|
-
| `ouputDir`
|
|
124
|
-
| `proxy`
|
|
125
|
-
| `template`
|
|
126
|
-
| `downloadUrl`
|
|
127
|
-
| `hideSendButton`
|
|
128
|
-
| `showExtensions`
|
|
129
|
-
| `sidebarOptions`
|
|
130
|
-
| `version`
|
|
131
|
-
| `label`
|
|
132
|
-
| `baseUrl`
|
|
133
|
-
| `versions`
|
|
120
|
+
| Name | Type | Default | Description |
|
|
121
|
+
| -------------------- | --------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
122
|
+
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
|
|
123
|
+
| `ouputDir` | `string` | `null` | Desired output path for generated MDX files. |
|
|
124
|
+
| `proxy` | `string` | `null` | _Optional:_ Proxy URL to prepend to base URL when performing API requests from browser. |
|
|
125
|
+
| `template` | `string` | `null` | _Optional:_ Customize MDX content with a desired template. |
|
|
126
|
+
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading OpenAPI specification. (requires `info` section/doc) |
|
|
127
|
+
| `hideSendButton` | `boolean` | `null` | _Optional:_ If set to `true`, hides the "Send API Request" button in API demo panel |
|
|
128
|
+
| `showExtensions` | `boolean` | `null` | _Optional:_ If set to `true`, renders operation-level vendor-extensions in description. |
|
|
129
|
+
| `sidebarOptions` | `object` | `null` | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options. |
|
|
130
|
+
| `version` | `string` | `null` | _Optional:_ Version assigned to single or micro-spec API specified in `specPath`. |
|
|
131
|
+
| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. |
|
|
132
|
+
| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating version selector dropdown menu. |
|
|
133
|
+
| `versions` | `object` | `null` | _Optional:_ Set of options for versioning configuration. See below for a list of supported options. |
|
|
134
|
+
| `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. |
|
|
134
135
|
|
|
135
136
|
`sidebarOptions` can be configured with the following options:
|
|
136
137
|
|
|
@@ -155,6 +156,16 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
|
|
|
155
156
|
|
|
156
157
|
> All versions will automatically inherit `sidebarOptions` from the parent/base config.
|
|
157
158
|
|
|
159
|
+
### markdownGenerators
|
|
160
|
+
|
|
161
|
+
`markdownGenerators` can be configured with the following options:
|
|
162
|
+
|
|
163
|
+
| Name | Type | Default | Description |
|
|
164
|
+
| ------------------ | ---------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
165
|
+
| `createApiPageMD` | `function` | `null` | _Optional:_ Returns a string of the raw markdown body for API pages.<br/><br/>**Function type:** `(pageData: ApiPageMetadata) => string` |
|
|
166
|
+
| `createInfoPageMD` | `function` | `null` | _Optional:_ Returns a string of the raw markdown body for info pages.<br/><br/>**Function type:** `(pageData: InfoPageMetadata) => string` |
|
|
167
|
+
| `createTagPageMD` | `function` | `null` | _Optional:_ Returns a string of the raw markdown body for tag pages.<br/><br/>**Function type:** `(pageData: TagPageMetadata) => string` |
|
|
168
|
+
|
|
158
169
|
## CLI Usage
|
|
159
170
|
|
|
160
171
|
```bash
|
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-613",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"openapi",
|
|
@@ -68,5 +68,5 @@
|
|
|
68
68
|
"engines": {
|
|
69
69
|
"node": ">=14"
|
|
70
70
|
},
|
|
71
|
-
"gitHead": "
|
|
71
|
+
"gitHead": "00be84c53a273fbd3a28f3524db8b75cbeb293a7"
|
|
72
72
|
}
|