File tree Expand file tree Collapse file tree 8 files changed +31
-16
lines changed
docusaurus-plugin-openapi-docs
docusaurus-theme-openapi-docs Expand file tree Collapse file tree 8 files changed +31
-16
lines changed Original file line number Diff line number Diff line change
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
+
1
13
## 3.0.2 (Aug 14, 2024)
2
14
3
15
High level enhancements
Original file line number Diff line number Diff line change @@ -41,16 +41,17 @@ Key Features:
41
41
42
42
| Docusaurus OpenAPI Docs | Docusaurus |
43
43
| ----------------------- | --------------- |
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 ` |
45
46
| 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 ` |
47
48
48
49
## Bootstrapping from Template (new Docusaurus site)
49
50
50
51
Run the following to bootstrap a Docsaurus v3 site (classic theme) with ` docusaurus-openapi-docs ` :
51
52
52
53
``` 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
54
55
```
55
56
56
57
> When prompted to select a template choose ` Git repository ` .
Original file line number Diff line number Diff line change @@ -58,9 +58,10 @@ Key Features:
58
58
59
59
| Docusaurus OpenAPI Docs | Docusaurus |
60
60
| ----------------------- | --------------- |
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 ` |
62
63
| 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 ` |
64
65
65
66
66
67
:::tip
@@ -72,7 +73,7 @@ If you"re building a Docusaurus site from scratch the easiest way to get started
72
73
Run the following to bootstrap a Docsaurus v2 site (classic theme) with ` docusaurus-openapi-docs ` :
73
74
74
75
``` 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
76
77
```
77
78
78
79
> When prompted to select a template choose ` Git repository ` .
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " demo" ,
3
- "version" : " 3 .0.2 " ,
3
+ "version" : " 4 .0.0 " ,
4
4
"private" : true ,
5
5
"scripts" : {
6
6
"docusaurus" : " docusaurus" ,
25
25
"@docusaurus/plugin-google-gtag" : " 3.5.2" ,
26
26
"@docusaurus/preset-classic" : " 3.5.2" ,
27
27
"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 " ,
30
30
"prism-react-renderer" : " ^2.3.0" ,
31
31
"react" : " ^18.2.0" ,
32
32
"react-dom" : " ^18.2.0"
Original file line number Diff line number Diff line change 1
1
{
2
- "version" : " 3 .0.2 " ,
2
+ "version" : " 4 .0.0 " ,
3
3
"npmClient" : " yarn"
4
4
}
Original file line number Diff line number Diff line change @@ -41,16 +41,17 @@ Key Features:
41
41
42
42
| Docusaurus OpenAPI Docs | Docusaurus |
43
43
| ----------------------- | --------------- |
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 ` |
45
46
| 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 ` |
47
48
48
49
## Bootstrapping from Template (new Docusaurus site)
49
50
50
51
Run the following to bootstrap a Docsaurus v3 site (classic theme) with ` docusaurus-openapi-docs ` :
51
52
52
53
``` bash
53
- npx create-docusaurus@3.4.0 my -website --package-manager yarn
54
+ npx create-docusaurus@3.5.2my -website --package-manager yarn
54
55
```
55
56
56
57
> When prompted to select a template choose ` Git repository ` .
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " docusaurus-plugin-openapi-docs" ,
3
3
"description" : " OpenAPI plugin for Docusaurus." ,
4
- "version" : " 3 .0.2 " ,
4
+ "version" : " 4 .0.0 " ,
5
5
"license" : " MIT" ,
6
6
"keywords" : [
7
7
" openapi" ,
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " docusaurus-theme-openapi-docs" ,
3
3
"description" : " OpenAPI theme for Docusaurus." ,
4
- "version" : " 3 .0.2 " ,
4
+ "version" : " 4 .0.0 " ,
5
5
"license" : " MIT" ,
6
6
"keywords" : [
7
7
" openapi" ,
42
42
"clsx" : " ^1.1.1" ,
43
43
"copy-text-to-clipboard" : " ^3.1.0" ,
44
44
"crypto-js" : " ^4.1.1" ,
45
- "docusaurus-plugin-openapi-docs" : " ^3 .0.2 " ,
45
+ "docusaurus-plugin-openapi-docs" : " ^4 .0.0 " ,
46
46
"docusaurus-plugin-sass" : " ^0.2.3" ,
47
47
"file-saver" : " ^2.0.5" ,
48
48
"lodash" : " ^4.17.20" ,
You can’t perform that action at this time.
0 commit comments