Skip to content

Commit 2cfff9e

Browse files
authored
Prepare release v5.0.2 (#1443)
* Prepare release v5.0.2 * fix(template): use MDX-safe truncate marker in sample blog post The legacy HTML-comment form `<!--truncate-->` causes MDX 3 / Docusaurus 3.10 to fail with "Unexpected character `!`" when building scaffolded sites. Switch to `{/* truncate */}`, which Docusaurus's blog plugin also recognizes and which is parseable as an MDX comment. * fix(template): rename long blog post to .mdx to preserve MDX comment Follow-up to 3129d39: prettier was mangling `{/* truncate */}` into `{/_ truncate _/}` because the file extension was `.md`, causing it to be parsed as Markdown where `*` is emphasis. Renaming to `.mdx` lets prettier preserve the MDX comment syntax intact.
1 parent a52230a commit 2cfff9e

7 files changed

Lines changed: 40 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
1+
## 5.0.2 (2026-05-01)
2+
3+
Routine maintenance release. Bumps Docusaurus to `3.10.1` in the demo and the `create-docusaurus-openapi-docs` scaffolder template (picks up the upstream webpackbar/webpack bundler fix), plus a batch of dependency updates. Also fixes a build error in scaffolded sites caused by an HTML comment in the sample blog post.
4+
5+
#### :bug: Bug Fix
6+
7+
- fix(template): replace `<!--truncate-->` with MDX-safe `{/* truncate */}` in sample blog post so scaffolded sites build under MDX 3 / Docusaurus 3.10
8+
9+
#### :robot: Dependencies
10+
11+
- chore(deps): bump @docusaurus/\* from 3.10.0 to 3.10.1 ([#1442](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1442))
12+
- chore(deps): bump postcss from 8.5.6 to 8.5.13 ([#1441](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1441))
13+
- chore(deps): bump @redocly/openapi-core from 2.25.4 to 2.29.0 ([#1430](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1430), [#1433](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1433))
14+
- chore(deps): bump react-hook-form from 7.72.1 to 7.73.1 ([#1436](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1436))
15+
- chore(deps): bump the react group with 2 updates ([#1426](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1426))
16+
- chore(deps): bump actions/setup-node from 6.3.0 to 6.4.0 ([#1438](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1438))
17+
- chore(deps): bump actions/cache from 5.0.4 to 5.0.5 ([#1431](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1431))
18+
- chore(deps): bump github/codeql-action from 4.35.1 to 4.35.2 ([#1439](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1439))
19+
20+
#### :wrench: Maintenance
21+
22+
- chore(deps-dev): bump fast-xml-parser from 5.5.10 to 5.7.1 ([#1429](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1429), [#1437](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1437))
23+
- chore(deps-dev): bump @types/node from 25.5.0 to 25.6.0 ([#1434](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1434))
24+
- chore(deps-dev): bump start-server-and-test from 3.0.0 to 3.0.2 ([#1428](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1428))
25+
- chore(deps-dev): bump eslint-plugin-react-hooks from 4.6.2 to 7.0.1 ([#1427](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1427))
26+
27+
#### Committers: 2
28+
29+
- dependabot[bot]
30+
- Steven Serrata
31+
132
## 5.0.1 (2026-04-14)
233

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

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.1",
2+
"version": "5.0.2",
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.1",
4+
"version": "5.0.2",
55
"license": "MIT",
66
"keywords": [
77
"openapi",

packages/create-docusaurus-openapi-docs/templates/default/blog/2019-05-29-long-blog-post.md renamed to packages/create-docusaurus-openapi-docs/templates/default/blog/2019-05-29-long-blog-post.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ tags: [hello, docusaurus]
77

88
This is the summary of a very long blog post,
99

10-
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
10+
Use a `{/* truncate */}` comment to limit blog post size in the list view.
1111

12-
<!--truncate-->
12+
{/* truncate */}
1313

1414
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
1515

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.1",
2424
"@mdx-js/react": "^3.0.0",
2525
"clsx": "^2.0.0",
26-
"docusaurus-plugin-openapi-docs": "5.0.1",
27-
"docusaurus-theme-openapi-docs": "5.0.1",
26+
"docusaurus-plugin-openapi-docs": "5.0.2",
27+
"docusaurus-theme-openapi-docs": "5.0.2",
2828
"prism-react-renderer": "^2.3.0",
2929
"react": "^19.0.0",
3030
"react-dom": "^19.0.0"

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.1",
4+
"version": "5.0.2",
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.1",
4+
"version": "5.0.2",
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.1",
41+
"docusaurus-plugin-openapi-docs": "^5.0.2",
4242
"docusaurus-plugin-sass": "^0.2.6",
4343
"eslint-plugin-prettier": "^5.5.1"
4444
},

0 commit comments

Comments
 (0)