Skip to content

Commit e63ca9f

Browse files
authored
Prepare release v5.0.1 (#1425)
1 parent 2b42766 commit e63ca9f

8 files changed

Lines changed: 67 additions & 32 deletions

File tree

CHANGELOG.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,44 @@
1+
## 5.0.1 (2026-04-14)
2+
3+
Patch release with a new scaffolding CLI, performance improvements, compatibility fixes for Docusaurus 3.10.0 strict admonition syntax, and a security fix for axios CVEs.
4+
5+
#### :rocket: New Feature
6+
7+
- feat: add create-docusaurus-openapi-docs CLI package ([#1413](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1413))
8+
9+
#### :bug: Bug Fix
10+
11+
- Fix deprecation notice for Docusaurus 3.10.0 strict admonition syntax ([#1423](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1423))
12+
- fix: rename experimental_faster to faster, remove --ignore from canary ([#1415](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1415))
13+
- fix: update axios resolution to ^1.15.0 to address critical CVEs
14+
15+
#### :running_woman: Performance
16+
17+
- perf: use Clipboard API ([#1416](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1416))
18+
19+
#### :robot: Dependencies
20+
21+
- chore(deps): bump follow-redirects from 1.15.11 to 1.16.0 ([#1424](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1424))
22+
- chore(deps): bump unist-util-visit from 5.0.0 to 5.1.0 ([#1422](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1422))
23+
- chore(deps): bump commander from 12.1.0 to 14.0.3 ([#1421](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1421))
24+
- chore(deps): bump react-hook-form from 7.72.0 to 7.72.1 ([#1409](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1409))
25+
26+
#### :wrench: Maintenance
27+
28+
- chore(deps-dev): bump @typescript-eslint/eslint-plugin ([#1419](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1419))
29+
- chore(deps-dev): bump eslint-plugin-cypress from 2.15.2 to 3.6.0 ([#1420](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1420))
30+
- chore(deps-dev): bump nodemon from 2.0.22 to 3.1.14 ([#1408](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1408))
31+
- chore(deps-dev): bump @types/lodash from 4.17.23 to 4.17.24 ([#1406](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1406))
32+
- chore(deps-dev): bump lint-staged from 11.2.6 to 16.4.0 ([#1411](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1411))
33+
- chore(deps-dev): bump eslint-plugin-testing-library from 6.5.0 to 7.16.2 ([#1410](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1410))
34+
35+
#### Committers: 4
36+
37+
- dependabot[bot]
38+
- Florian Lefebvre
39+
- Ollie Monk
40+
- Steven Serrata
41+
142
## 5.0.0 (2026-04-08)
243

344
**Breaking Change:** Minimum Docusaurus version is now `3.10.0`. Users on Docusaurus 3.5–3.9 must upgrade before updating to this release.

demo/docs/intro.mdx

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -85,34 +85,31 @@ Other ReDoc specific extensions such as `x-circular-ref`, `x-code-samples` (depr
8585

8686

8787
:::tip
88-
If you're building a Docusaurus site from scratch, the easiest way to get started is by [installing from template](#bootstrapping-from-template-new-docusaurus-site).
88+
If you're building a Docusaurus site from scratch, the easiest way to get started is with the [Quick Start](#quick-start-new-docusaurus-site) CLI.
8989
:::
9090

91-
## Bootstrapping from Template (new Docusaurus site)
91+
## Quick Start (new Docusaurus site)
9292

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

9595
```bash
96-
npx create-docusaurus@3.10.0 my-website --package-manager yarn
96+
npx create-docusaurus-openapi-docs my-website
9797
```
9898

99-
> When prompted to select a template choose `Git repository`.
100-
101-
Template Repository URL:
102-
103-
```bash
104-
https://github.com/PaloAltoNetworks/docusaurus-template-openapi-docs.git
105-
```
106-
107-
> When asked how the template repo should be cloned choose "copy" (unless you know better).
108-
10999
```bash
110100
cd my-website
111101
yarn start
112102
```
113103

114104
If all goes well, you should be greeted by a brand new Docusaurus site that includes API reference docs for the ubiquitous Petstore API!
115105

106+
### CLI Options
107+
108+
| Option | Description |
109+
| --------------------------------- | ----------------------------------------------------- |
110+
| `-p, --package-manager <manager>` | Use a specific package manager (yarn, npm, pnpm, bun) |
111+
| `-s, --skip-install` | Skip automatic dependency installation |
112+
116113
## Installation (existing Docusaurus site)
117114

118115
:::note

lerna.json

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

packages/create-docusaurus-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": "create-docusaurus-openapi-docs",
33
"description": "Create Docusaurus sites with OpenAPI docs.",
4-
"version": "5.0.0",
4+
"version": "5.0.1",
55
"license": "MIT",
66
"keywords": [
77
"openapi",

packages/create-docusaurus-openapi-docs/templates/default/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
"@docusaurus/preset-classic": "3.10.0",
2424
"@mdx-js/react": "^3.0.0",
2525
"clsx": "^2.0.0",
26-
"docusaurus-plugin-openapi-docs": "PLACEHOLDER",
27-
"docusaurus-theme-openapi-docs": "PLACEHOLDER",
26+
"docusaurus-plugin-openapi-docs": "5.0.1",
27+
"docusaurus-theme-openapi-docs": "5.0.1",
2828
"prism-react-renderer": "^2.3.0",
2929
"react": "^19.0.0",
3030
"react-dom": "^19.0.0"

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,31 +47,28 @@ Key Features:
4747
| 2.2.3 (end-of-support) | `2.4.1 - 2.4.3` |
4848
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
4949

50-
## Bootstrapping from Template (new Docusaurus site)
50+
## Quick Start (new Docusaurus site)
5151

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

5454
```bash
55-
npx create-docusaurus@3.10.0 my-website --package-manager yarn
55+
npx create-docusaurus-openapi-docs my-website
5656
```
5757

58-
> When prompted to select a template choose `Git repository`.
59-
60-
Template Repository URL:
61-
62-
```bash
63-
https://github.com/PaloAltoNetworks/docusaurus-template-openapi-docs.git
64-
```
65-
66-
> When asked how the template repo should be cloned choose "copy".
67-
6858
```bash
6959
cd my-website
7060
yarn start
7161
```
7262

7363
If all goes well, you should be greeted by a brand new Docusaurus site that includes API reference docs for the ubiquitous Petstore API!
7464

65+
### CLI Options
66+
67+
| Option | Description |
68+
| --------------------------------- | ----------------------------------------------------- |
69+
| `-p, --package-manager <manager>` | Use a specific package manager (yarn, npm, pnpm, bun) |
70+
| `-s, --skip-install` | Skip automatic dependency installation |
71+
7572
## Installation (existing Docusaurus site)
7673

7774
> Both the plugin and theme are currently designed to pair with a specific Docusaurus release. The Docusaurus badge in the `README.md` and at the top of this page will always reflect the current compatible versions.

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": "5.0.0",
4+
"version": "5.0.1",
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": "5.0.0",
4+
"version": "5.0.1",
55
"license": "MIT",
66
"keywords": [
77
"openapi",
@@ -38,7 +38,7 @@
3838
"@types/postman-collection": "^3.5.11",
3939
"@types/react-modal": "^3.16.3",
4040
"concurrently": "^9.2.0",
41-
"docusaurus-plugin-openapi-docs": "^5.0.0",
41+
"docusaurus-plugin-openapi-docs": "^5.0.1",
4242
"docusaurus-plugin-sass": "^0.2.6",
4343
"eslint-plugin-prettier": "^5.5.1"
4444
},

0 commit comments

Comments
 (0)