Skip to content

Commit 79d7417

Browse files
authored
Prepare relesae v4.0.0 (#921)
1 parent 02e0ae8 commit 79d7417

File tree

8 files changed

+31
-16
lines changed

8 files changed

+31
-16
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
## 4.0.0 (Aug 20, 2024)
2+
3+
High level enhancements
4+
5+
- Introduce support for Docusaurus 3.5.0+
6+
7+
> Note that this breaks backward compatibility and users will need to update their Docusaurus installation to 3.5.0 or later to use this version of the plugin.
8+
9+
Other enhancements and bug fixes
10+
11+
- Introduce support for Docusaurus 3.5.0+ ([#919](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/919))
12+
113
## 3.0.2 (Aug 14, 2024)
214

315
High level enhancements

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,17 @@ Key Features:
4141

4242
| Docusaurus OpenAPI Docs | Docusaurus |
4343
| ----------------------- | --------------- |
44-
| 3.0.2 (current) | `3.0.1 - 3.4.0` |
44+
| 4.0.0 (current) | `3.5.0 - 3.5.2` |
45+
| 3.0.2 (legacy) | `3.0.1 - 3.4.0` |
4546
| 2.2.1 (legacy) | `2.4.1 - 2.4.3` |
46-
| 1.7.3 (legacy) | `2.0.1 - 2.2.0` |
47+
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
4748

4849
## Bootstrapping from Template (new Docusaurus site)
4950

5051
Run the following to bootstrap a Docsaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
5152

5253
```bash
53-
npx create-docusaurus@3.4.0 my-website --package-manager yarn
54+
npx create-docusaurus@3.5.2 my-website --package-manager yarn
5455
```
5556

5657
> When prompted to select a template choose `Git repository`.

demo/docs/intro.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,10 @@ Key Features:
5858

5959
| Docusaurus OpenAPI Docs | Docusaurus |
6060
| ----------------------- | --------------- |
61-
| 3.0.2 (current) | `3.0.1 - 3.4.0` |
61+
| 4.0.0 (current) | `3.5.0 - 3.5.2` |
62+
| 3.0.2 (legacy) | `3.0.1 - 3.4.0` |
6263
| 2.2.1 (legacy) | `2.4.1 - 2.4.3` |
63-
| 1.7.3 (legacy) | `2.0.1 - 2.2.0` |
64+
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
6465

6566

6667
:::tip
@@ -72,7 +73,7 @@ If you"re building a Docusaurus site from scratch the easiest way to get started
7273
Run the following to bootstrap a Docsaurus v2 site (classic theme) with `docusaurus-openapi-docs`:
7374

7475
```bash
75-
npx create-docusaurus@3.4.0 my-website --package-manager yarn
76+
npx create-docusaurus@3.5.2 my-website --package-manager yarn
7677
```
7778

7879
> When prompted to select a template choose `Git repository`.

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": "3.0.2",
3+
"version": "4.0.0",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
@@ -25,8 +25,8 @@
2525
"@docusaurus/plugin-google-gtag": "3.5.2",
2626
"@docusaurus/preset-classic": "3.5.2",
2727
"clsx": "^1.1.1",
28-
"docusaurus-plugin-openapi-docs": "^3.0.2",
29-
"docusaurus-theme-openapi-docs": "^3.0.2",
28+
"docusaurus-plugin-openapi-docs": "^4.0.0",
29+
"docusaurus-theme-openapi-docs": "^4.0.0",
3030
"prism-react-renderer": "^2.3.0",
3131
"react": "^18.2.0",
3232
"react-dom": "^18.2.0"

lerna.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"version": "3.0.2",
2+
"version": "4.0.0",
33
"npmClient": "yarn"
44
}

packages/docusaurus-plugin-openapi-docs/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,17 @@ Key Features:
4141

4242
| Docusaurus OpenAPI Docs | Docusaurus |
4343
| ----------------------- | --------------- |
44-
| 3.0.2 (current) | `3.0.1 - 3.4.0` |
44+
| 4.0.0 (current) | `3.5.0 - 3.5.2` |
45+
| 3.0.2 (legacy) | `3.0.1 - 3.4.0` |
4546
| 2.2.1 (legacy) | `2.4.1 - 2.4.3` |
46-
| 1.7.3 (legacy) | `2.0.1 - 2.2.0` |
47+
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
4748

4849
## Bootstrapping from Template (new Docusaurus site)
4950

5051
Run the following to bootstrap a Docsaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
5152

5253
```bash
53-
npx create-docusaurus@3.4.0 my-website --package-manager yarn
54+
npx create-docusaurus@3.5.2my-website --package-manager yarn
5455
```
5556

5657
> When prompted to select a template choose `Git repository`.

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": "3.0.2",
4+
"version": "4.0.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": "3.0.2",
4+
"version": "4.0.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",
@@ -42,7 +42,7 @@
4242
"clsx": "^1.1.1",
4343
"copy-text-to-clipboard": "^3.1.0",
4444
"crypto-js": "^4.1.1",
45-
"docusaurus-plugin-openapi-docs": "^3.0.2",
45+
"docusaurus-plugin-openapi-docs": "^4.0.0",
4646
"docusaurus-plugin-sass": "^0.2.3",
4747
"file-saver": "^2.0.5",
4848
"lodash": "^4.17.20",

0 commit comments

Comments
 (0)