Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare release v4.0.0 #921

Merged
merged 1 commit into from
Aug 20, 2024
Merged

Prepare release v4.0.0 #921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
## 4.0.0 (Aug 20, 2024)

High level enhancements

- Introduce support for Docusaurus 3.5.0+

> 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.

Other enhancements and bug fixes

- Introduce support for Docusaurus 3.5.0+ ([#919](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/919))

## 3.0.2 (Aug 14, 2024)

High level enhancements
Expand Down
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,17 @@ Key Features:

| Docusaurus OpenAPI Docs | Docusaurus |
| ----------------------- | --------------- |
| 3.0.2 (current) | `3.0.1 - 3.4.0` |
| 4.0.0 (current) | `3.5.0 - 3.5.2` |
| 3.0.2 (legacy) | `3.0.1 - 3.4.0` |
| 2.2.1 (legacy) | `2.4.1 - 2.4.3` |
| 1.7.3 (legacy) | `2.0.1 - 2.2.0` |
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |

## Bootstrapping from Template (new Docusaurus site)

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

```bash
npx create-docusaurus@3.4.0 my-website --package-manager yarn
npx create-docusaurus@3.5.2 my-website --package-manager yarn
```

> When prompted to select a template choose `Git repository`.
Expand Down
7 changes: 4 additions & 3 deletions demo/docs/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,10 @@ Key Features:

| Docusaurus OpenAPI Docs | Docusaurus |
| ----------------------- | --------------- |
| 3.0.2 (current) | `3.0.1 - 3.4.0` |
| 4.0.0 (current) | `3.5.0 - 3.5.2` |
| 3.0.2 (legacy) | `3.0.1 - 3.4.0` |
| 2.2.1 (legacy) | `2.4.1 - 2.4.3` |
| 1.7.3 (legacy) | `2.0.1 - 2.2.0` |
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |


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

```bash
npx create-docusaurus@3.4.0 my-website --package-manager yarn
npx create-docusaurus@3.5.2 my-website --package-manager yarn
```

> When prompted to select a template choose `Git repository`.
Expand Down
6 changes: 3 additions & 3 deletions demo/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "demo",
"version": "3.0.2",
"version": "4.0.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand All @@ -25,8 +25,8 @@
"@docusaurus/plugin-google-gtag": "3.5.2",
"@docusaurus/preset-classic": "3.5.2",
"clsx": "^1.1.1",
"docusaurus-plugin-openapi-docs": "^3.0.2",
"docusaurus-theme-openapi-docs": "^3.0.2",
"docusaurus-plugin-openapi-docs": "^4.0.0",
"docusaurus-theme-openapi-docs": "^4.0.0",
"prism-react-renderer": "^2.3.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Expand Down
2 changes: 1 addition & 1 deletion lerna.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"version": "3.0.2",
"version": "4.0.0",
"npmClient": "yarn"
}
7 changes: 4 additions & 3 deletions packages/docusaurus-plugin-openapi-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,17 @@ Key Features:

| Docusaurus OpenAPI Docs | Docusaurus |
| ----------------------- | --------------- |
| 3.0.2 (current) | `3.0.1 - 3.4.0` |
| 4.0.0 (current) | `3.5.0 - 3.5.2` |
| 3.0.2 (legacy) | `3.0.1 - 3.4.0` |
| 2.2.1 (legacy) | `2.4.1 - 2.4.3` |
| 1.7.3 (legacy) | `2.0.1 - 2.2.0` |
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |

## Bootstrapping from Template (new Docusaurus site)

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

```bash
npx create-docusaurus@3.4.0 my-website --package-manager yarn
npx create-docusaurus@3.5.2my-website --package-manager yarn
```

> When prompted to select a template choose `Git repository`.
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-openapi-docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "docusaurus-plugin-openapi-docs",
"description": "OpenAPI plugin for Docusaurus.",
"version": "3.0.2",
"version": "4.0.0",
"license": "MIT",
"keywords": [
"openapi",
Expand Down
4 changes: 2 additions & 2 deletions packages/docusaurus-theme-openapi-docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "docusaurus-theme-openapi-docs",
"description": "OpenAPI theme for Docusaurus.",
"version": "3.0.2",
"version": "4.0.0",
"license": "MIT",
"keywords": [
"openapi",
Expand Down Expand Up @@ -42,7 +42,7 @@
"clsx": "^1.1.1",
"copy-text-to-clipboard": "^3.1.0",
"crypto-js": "^4.1.1",
"docusaurus-plugin-openapi-docs": "^3.0.2",
"docusaurus-plugin-openapi-docs": "^4.0.0",
"docusaurus-plugin-sass": "^0.2.3",
"file-saver": "^2.0.5",
"lodash": "^4.17.20",
Expand Down
Loading