Skip to content

Commit 4b9ac92

Browse files
authored
Prepare release v1.7.0 (#512)
* Prepare release v1.7.0 * Add compatibility matrix
1 parent 14e3a21 commit 4b9ac92

File tree

8 files changed

+66
-27
lines changed

8 files changed

+66
-27
lines changed

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
## 1.7.0 (Mar 20, 2023)
2+
3+
High level enhancements
4+
5+
- Added support for powershell
6+
- Now including `language / variant` in code block title.
7+
8+
Other enhancements and bug fixes
9+
10+
- [Bug] Fix double scrollbars ([#504](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/504))
11+
- [Enhancement] Add support for powershell ([#507](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/507))
12+
- Bump webpack from 5.75.0 to 5.76.0 ([#498](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/498))
13+
- [Bug] Set ignoreAdditionalProperties back to true ([#493](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/493))
14+
- [Bug] Add bold, svg and ensure parity between opening/closing regex ([#479](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/479))
15+
116
## 1.6.1 (Feb 28, 2023)
217

318
High level enhancements

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,13 @@ Theme:
5151
yarn add docusaurus-theme-openapi-docs
5252
```
5353

54+
## Compatibility Matrix
55+
56+
| Docusaurus OpenAPI Docs | Docusaurus |
57+
| ----------------------- | ---------------- |
58+
| 1.x.x | `>=2.0.1 <2.3.0` |
59+
| 2.x.x (beta) | `>=2.3.0` |
60+
5461
## Configuring `docusaurus.config.js` (Plugin and theme usage)
5562

5663
Here is an example of properly configuring your `docusaurus.config.js` file for `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` usage.

demo/docs/customization/languagetabs.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,17 @@ description: Configuring language tabs for the API Demo Panel.
1010

1111
The Docusaurus OpenAPI docs plugin comes with support for 8 languages which you can render as code snippets on an API operation page. The languages currently supported are:
1212

13-
| Language | Prism Highlighter | Variants |
14-
| -------- | ----------------- | ------------------------------------------------ |
15-
| `curl` | bash | `curl`\* |
16-
| `python` | python | `requests`\*, `http.client` |
17-
| `go` | go | `native`\* |
18-
| `nodejs` | javascript | `axios`\*, `native`, `requests`, `unirest` |
19-
| `ruby` | ruby | `net::http`\* |
20-
| `csharp` | csharp | `restsharp`\*, `httpclient` |
21-
| `php` | php | `curl`\*, `guzzle`, `pecl_http`, `http_request2` |
22-
| `java` | java | `okhttp`\*, `unirest` |
13+
| Language | Prism Highlighter | Variants |
14+
| ------------ | ----------------- | ------------------------------------------------ |
15+
| `curl` | bash | `curl`\* |
16+
| `python` | python | `requests`\*, `http.client` |
17+
| `go` | go | `native`\* |
18+
| `nodejs` | javascript | `axios`\*, `native`, `requests`, `unirest` |
19+
| `ruby` | ruby | `net::http`\* |
20+
| `csharp` | csharp | `restsharp`\*, `httpclient` |
21+
| `php` | php | `curl`\*, `guzzle`, `pecl_http`, `http_request2` |
22+
| `java` | java | `okhttp`\*, `unirest` |
23+
| `powershell` | powershell | `RestMethod`\* |
2324

2425
\* Default variant
2526

@@ -60,6 +61,7 @@ The demo site disables the `ruby` and `php` languages using the following `langu
6061
highlight: "python",
6162
language: "python",
6263
logoClass: "python",
64+
variant: "requests",
6365
},
6466
{
6567
highlight: "go",
@@ -70,26 +72,34 @@ The demo site disables the `ruby` and `php` languages using the following `langu
7072
highlight: "javascript",
7173
language: "nodejs",
7274
logoClass: "nodejs",
75+
variant: "axios",
76+
},
77+
{
78+
highlight: "ruby",
79+
language: "ruby",
80+
logoClass: "ruby",
7381
},
74-
// {
75-
// highlight: "ruby",
76-
// language: "ruby",
77-
// logoClass: "ruby",
78-
// },
7982
{
8083
highlight: "csharp",
8184
language: "csharp",
8285
logoClass: "csharp",
86+
variant: "httpclient",
87+
},
88+
{
89+
highlight: "php",
90+
language: "php",
91+
logoClass: "php",
8392
},
84-
// {
85-
// highlight: "php",
86-
// language: "php",
87-
// logoClass: "php",
88-
// },
8993
{
9094
highlight: "java",
9195
language: "java",
9296
logoClass: "java",
97+
variant: "unirest",
98+
},
99+
{
100+
highlight: "powershell",
101+
language: "powershell",
102+
logoClass: "powershell",
93103
},
94104
],
95105
```

demo/docs/intro.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ Theme:
7676
yarn add docusaurus-theme-openapi-docs
7777
```
7878

79+
## Compatibility Matrix
80+
81+
| Docusaurus OpenAPI Docs | Docusaurus |
82+
| ----------------------- | ---------------- |
83+
| 1.x.x | `>=2.0.1 <2.3.0` |
84+
| 2.x.x (beta) | `>=2.3.0` |
85+
7986
## Configuration
8087

8188
### Configuring the plugin

demo/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "demo",
3-
"version": "1.6.1",
3+
"version": "1.7.0",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
@@ -27,8 +27,8 @@
2727
"@docusaurus/preset-classic": ">=2.0.1 <2.3.0",
2828
"@mdx-js/react": "^1.6.22",
2929
"clsx": "^1.1.1",
30-
"docusaurus-plugin-openapi-docs": "^1.6.1",
31-
"docusaurus-theme-openapi-docs": "^1.6.1",
30+
"docusaurus-plugin-openapi-docs": "^1.7.0",
31+
"docusaurus-theme-openapi-docs": "^1.7.0",
3232
"prism-react-renderer": "^1.3.1",
3333
"react": "^17.0.2",
3434
"react-dom": "^17.0.2"

lerna.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "1.6.1",
2+
"version": "1.7.0",
33
"npmClient": "yarn",
44
"useWorkspaces": true
55
}

packages/docusaurus-plugin-openapi-docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docusaurus-plugin-openapi-docs",
33
"description": "OpenAPI plugin for Docusaurus.",
4-
"version": "1.6.1",
4+
"version": "1.7.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",

packages/docusaurus-theme-openapi-docs/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docusaurus-theme-openapi-docs",
33
"description": "OpenAPI theme for Docusaurus.",
4-
"version": "1.6.1",
4+
"version": "1.7.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",
@@ -51,7 +51,7 @@
5151
"buffer": "^6.0.3",
5252
"clsx": "^1.1.1",
5353
"crypto-js": "^4.1.1",
54-
"docusaurus-plugin-openapi-docs": "^1.6.1",
54+
"docusaurus-plugin-openapi-docs": "^1.7.0",
5555
"file-saver": "^2.0.5",
5656
"immer": "^9.0.7",
5757
"lodash": "^4.17.20",

0 commit comments

Comments
 (0)