@kong/spec-renderer 1.94.32 → 1.94.33
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 +10 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,26 +1,28 @@
|
|
|
1
1
|
# Kong Spec Renderer
|
|
2
2
|
|
|
3
|
-
> [!IMPORTANT]
|
|
4
|
-
> This repository and the `@kong/spec-renderer` package are currently in development on the `main` branch. Breaking changes should be expected.
|
|
5
|
-
>
|
|
6
|
-
> Once the `1.x` version is ready, the package name will change to `@kong/spec-renderer`.
|
|
7
|
-
|
|
8
3
|
Kong's open-source spec renderer.
|
|
9
4
|
|
|
10
|
-
|
|
5
|
+
An online API specification editor is available at [api-documentation.dev](https://api-documentation.dev), and you can view the extended usage example [in the source repository](https://github.com/Kong/spec-editor).
|
|
6
|
+
|
|
7
|
+
## Table of Contents
|
|
11
8
|
|
|
12
9
|
- [Installation](#installation)
|
|
13
10
|
- [Usage](#usage)
|
|
14
11
|
- [Vue 3 Component(s)](#vue-3-components)
|
|
15
12
|
- [Vue 3 Plugin](#vue-3-plugin)
|
|
16
13
|
- [No/Other framework via native web components](#noother-framework-via-native-web-components)
|
|
14
|
+
- [Example for react](#-example-for-react)
|
|
15
|
+
- [Example for html/script](#-example-for-htmlscript)
|
|
17
16
|
- [Props](#props)
|
|
18
|
-
- [
|
|
17
|
+
- [v-model](#v-model)
|
|
18
|
+
- [Contributing & Local Development](#contributing--local-development)
|
|
19
19
|
- [Development Sandbox](#development-sandbox)
|
|
20
|
+
- [Build and Preview the Development Sandbox](#build-and-preview-the-development-sandbox)
|
|
20
21
|
- [Lint and fix](#lint-and-fix)
|
|
21
22
|
- [Testing](#testing)
|
|
22
23
|
- [Build for production](#build-for-production)
|
|
23
24
|
- [Committing Changes](#committing-changes)
|
|
25
|
+
- [Enforcing Commit Format](#enforcing-commit-format)
|
|
24
26
|
- [Approvals](#approvals)
|
|
25
27
|
- [Package Publishing](#package-publishing)
|
|
26
28
|
- [Third-party packages and Thank You](#third-party-packages-and-thank-you)
|
|
@@ -308,6 +310,6 @@ This repository utilizes [Semantic Release](https://github.com/semantic-release/
|
|
|
308
310
|
|
|
309
311
|
- Thank You [Stoplight](https://stoplight.io/) for beautiful parser and AST producer [stoplight/http-spec](https://github.com/stoplightio/http-spec).
|
|
310
312
|
|
|
311
|
-
- Thank You [Stoplight](https://stoplight.io/) for excellent approach for dealing with specification's table of contents and specification's security definitions. Found in [elements](https://github.com/stoplightio/elements) and currently placed into [src/stoplight](src/stoplight/), while [PR]() back to elements package pending.
|
|
313
|
+
- Thank You [Stoplight](https://stoplight.io/) for excellent approach for dealing with specification's table of contents and specification's security definitions. Found in [elements](https://github.com/stoplightio/elements) and currently placed into [src/stoplight](src/stoplight/), while [PR](https://github.com/stoplightio/elements/pull/2751) back to elements package pending.
|
|
312
314
|
|
|
313
315
|
- Thank You [AsyncApi](https://www.asyncapi.com/) for superb [@asyncapi/parser](https://github.com/asyncapi/parser-js).
|