@kubb/plugin-redoc 5.0.0-beta.3 → 5.0.0-beta.4
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/dist/index.cjs +1 -1
- package/dist/index.js +1 -1
- package/extension.yaml +67 -0
- package/package.json +4 -4
package/dist/index.cjs
CHANGED
|
@@ -52,7 +52,7 @@ function trimExtName(text) {
|
|
|
52
52
|
}
|
|
53
53
|
//#endregion
|
|
54
54
|
//#region package.json
|
|
55
|
-
var version = "5.0.0-beta.
|
|
55
|
+
var version = "5.0.0-beta.4";
|
|
56
56
|
//#endregion
|
|
57
57
|
//#region src/redoc.tsx
|
|
58
58
|
const __filename$1 = (0, node_url.fileURLToPath)(require("url").pathToFileURL(__filename).href);
|
package/dist/index.js
CHANGED
package/extension.yaml
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
$schema: https://kubb.dev/schemas/extension.json
|
|
2
|
+
kind: plugin
|
|
3
|
+
id: plugin-redoc
|
|
4
|
+
name: Redoc
|
|
5
|
+
description: Generate API documentation with Redoc from OpenAPI specifications.
|
|
6
|
+
category: documentation
|
|
7
|
+
type: official
|
|
8
|
+
npmPackage: "@kubb/plugin-redoc"
|
|
9
|
+
docsPath: /plugins/plugin-redoc
|
|
10
|
+
repo: https://github.com/kubb-labs/plugins
|
|
11
|
+
maintainers:
|
|
12
|
+
- name: Stijn Van Hulle
|
|
13
|
+
github: stijnvanhulle
|
|
14
|
+
compatibility:
|
|
15
|
+
kubb: ">=5.0.0"
|
|
16
|
+
node: ">=22"
|
|
17
|
+
tags:
|
|
18
|
+
- redoc
|
|
19
|
+
- api-docs
|
|
20
|
+
- documentation
|
|
21
|
+
- interactive-docs
|
|
22
|
+
- codegen
|
|
23
|
+
- openapi
|
|
24
|
+
dependencies: []
|
|
25
|
+
resources:
|
|
26
|
+
documentation: https://kubb.dev/plugins/plugin-redoc
|
|
27
|
+
repository: https://github.com/kubb-labs/plugins
|
|
28
|
+
issues: https://github.com/kubb-labs/plugins/issues
|
|
29
|
+
changelog: https://github.com/kubb-labs/plugins/blob/main/packages/plugin-redoc/CHANGELOG.md
|
|
30
|
+
codesandbox: https://codesandbox.io/p/github/kubb-labs/plugins/main/examples/simple-single
|
|
31
|
+
featured: false
|
|
32
|
+
icon:
|
|
33
|
+
light: https://kubb.dev/feature/openapi.svg
|
|
34
|
+
intro: |
|
|
35
|
+
Generate interactive API documentation from your OpenAPI schema using [Redoc](https://redocly.com/).
|
|
36
|
+
options:
|
|
37
|
+
- name: output
|
|
38
|
+
type: "{ path: string }"
|
|
39
|
+
required: false
|
|
40
|
+
description: Specify the output path for the generated documentation HTML file.
|
|
41
|
+
properties:
|
|
42
|
+
- name: path
|
|
43
|
+
type: string
|
|
44
|
+
required: true
|
|
45
|
+
description: |
|
|
46
|
+
The output file path for the generated documentation HTML.
|
|
47
|
+
tip: |
|
|
48
|
+
if `output.path` is a file, `group` cannot be used.
|
|
49
|
+
default: "'docs.html'"
|
|
50
|
+
examples:
|
|
51
|
+
- name: kubb.config.ts
|
|
52
|
+
files:
|
|
53
|
+
- lang: typescript
|
|
54
|
+
code: |
|
|
55
|
+
import { defineConfig } from 'kubb'
|
|
56
|
+
import { pluginRedoc } from '@kubb/plugin-redoc'
|
|
57
|
+
|
|
58
|
+
export default defineConfig({
|
|
59
|
+
input: { path: './petStore.yaml' },
|
|
60
|
+
output: { path: './src/gen' },
|
|
61
|
+
plugins: [
|
|
62
|
+
pluginRedoc({
|
|
63
|
+
output: { path: 'docs.html' },
|
|
64
|
+
}),
|
|
65
|
+
],
|
|
66
|
+
})
|
|
67
|
+
twoslash: false
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kubb/plugin-redoc",
|
|
3
|
-
"version": "5.0.0-beta.
|
|
3
|
+
"version": "5.0.0-beta.4",
|
|
4
4
|
"description": "Redoc documentation generator plugin for Kubb, creating beautiful, interactive API documentation from OpenAPI specifications.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"api-docs",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"src",
|
|
27
27
|
"dist",
|
|
28
28
|
"static",
|
|
29
|
-
"
|
|
29
|
+
"extension.yaml",
|
|
30
30
|
"!/**/**.test.**",
|
|
31
31
|
"!/**/__tests__/**",
|
|
32
32
|
"!/**/__snapshots__/**"
|
|
@@ -51,8 +51,8 @@
|
|
|
51
51
|
"registry": "https://registry.npmjs.org/"
|
|
52
52
|
},
|
|
53
53
|
"dependencies": {
|
|
54
|
-
"@kubb/adapter-oas": "5.0.0-beta.
|
|
55
|
-
"@kubb/core": "5.0.0-beta.
|
|
54
|
+
"@kubb/adapter-oas": "5.0.0-beta.4",
|
|
55
|
+
"@kubb/core": "5.0.0-beta.4",
|
|
56
56
|
"handlebars": "^4.7.9"
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|