Skip to content

Commit c39166a

Browse files
MattiasBuelensMattiasBuelens
authored
Update to Docusaurus 3.6 (#294)
1 parent aafdc8a commit c39166a

File tree

13 files changed

+2416
-692
lines changed

13 files changed

+2416
-692
lines changed

‎demo/docusaurus.config.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ const config = {
2626
},
2727
},
2828

29+
future: {
30+
experimental_faster: true,
31+
},
32+
2933
presets: [
3034
[
3135
"docusaurus-preset-openapi",

‎demo/package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
"write-heading-ids": "docusaurus write-heading-ids"
1515
},
1616
"dependencies": {
17-
"@docusaurus/core": "^3.2.0",
17+
"@docusaurus/core": "^3.6.0",
18+
"@docusaurus/faster": "^3.6.0",
1819
"@svgr/webpack": "^5.5.0",
1920
"clsx": "^1.2.1",
2021
"docusaurus-preset-openapi": "^0.7.5",

‎packages/create-docusaurus-openapi/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
},
2424
"license": "MIT",
2525
"dependencies": {
26-
"@docusaurus/logger": "^3.2.0",
26+
"@docusaurus/logger": "^3.6.0",
2727
"commander": "^5.1.0",
2828
"fs-extra": "^11.0.0",
2929
"lodash": "^4.17.20",

‎packages/docusaurus-plugin-openapi/package.json‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@
2121
"watch": "tsc --watch"
2222
},
2323
"devDependencies": {
24-
"@docusaurus/module-type-aliases": "^3.2.0",
25-
"@docusaurus/types": "^3.2.0",
24+
"@docusaurus/module-type-aliases": "^3.6.0",
25+
"@docusaurus/types": "^3.6.0",
2626
"@types/js-yaml": "^4.0.5",
2727
"@types/json-schema": "^7.0.9",
2828
"@types/lodash": "^4.14.176",
2929
"@types/postman-collection": "^3.5.3",
3030
"utility-types": "^3.10.0"
3131
},
3232
"dependencies": {
33-
"@docusaurus/mdx-loader": "^3.2.0",
34-
"@docusaurus/plugin-content-docs": "^3.2.0",
35-
"@docusaurus/utils": "^3.2.0",
36-
"@docusaurus/utils-common": "^3.2.0",
37-
"@docusaurus/utils-validation": "^3.2.0",
33+
"@docusaurus/mdx-loader": "^3.6.0",
34+
"@docusaurus/plugin-content-docs": "^3.6.0",
35+
"@docusaurus/utils": "^3.6.0",
36+
"@docusaurus/utils-common": "^3.6.0",
37+
"@docusaurus/utils-validation": "^3.6.0",
3838
"chalk": "^4.1.2",
3939
"clsx": "^1.2.1",
4040
"js-yaml": "^4.1.0",
@@ -43,7 +43,7 @@
4343
"lodash": "^4.17.20",
4444
"openapi-to-postmanv2": "^4.20.1",
4545
"postman-collection": "^4.1.0",
46-
"webpack": "^5.88.1"
46+
"webpack": "^5.95.0"
4747
},
4848
"peerDependencies": {
4949
"react": "^18.0.0",

‎packages/docusaurus-plugin-openapi/src/index.ts‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
import { readFile } from "node:fs/promises";
99
import { join, relative, resolve } from "node:path";
1010

11+
import type { Options as MDXLoaderOptions } from "@docusaurus/mdx-loader";
1112
import type {
1213
LoadContext,
1314
Plugin,
@@ -245,12 +246,13 @@ export default function pluginOpenAPI(
245246

246247
configureWebpack(
247248
_config: Configuration,
248-
isServer: boolean,
249-
{ getJSLoader }: ConfigureWebpackUtils
249+
_isServer: boolean,
250+
_configureWebpackUtils: ConfigureWebpackUtils
250251
) {
251252
const {
252253
rehypePlugins,
253254
remarkPlugins,
255+
recmaPlugins,
254256
beforeDefaultRehypePlugins,
255257
beforeDefaultRemarkPlugins,
256258
} = options;
@@ -267,15 +269,19 @@ export default function pluginOpenAPI(
267269
test: /(\.mdx?)$/,
268270
include: [dataDir, contentPath].map(addTrailingPathSeparator),
269271
use: [
270-
getJSLoader({ isServer }),
271272
{
272273
loader: require.resolve("@docusaurus/mdx-loader"),
273274
options: {
274275
admonitions: options.admonitions,
275276
remarkPlugins,
276277
rehypePlugins,
278+
recmaPlugins,
277279
beforeDefaultRehypePlugins,
278280
beforeDefaultRemarkPlugins,
281+
staticDirs: siteConfig.staticDirectories.map((dir) =>
282+
resolve(siteDir, dir)
283+
),
284+
siteDir,
279285
markdownConfig: siteConfig.markdown ?? { mdx1Compat: {} },
280286
metadataPath: (mdxPath: string) => {
281287
if (mdxPath.startsWith(dataDir)) {
@@ -287,7 +293,7 @@ export default function pluginOpenAPI(
287293
return join(dataDir, `${docuHash(aliasedSource)}.json`);
288294
}
289295
},
290-
},
296+
} satisfies MDXLoaderOptions,
291297
},
292298
].filter(Boolean),
293299
},

‎packages/docusaurus-plugin-openapi/src/options.ts‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import {
1010
Joi,
1111
RemarkPluginsSchema,
1212
RehypePluginsSchema,
13+
RecmaPluginsSchema,
1314
AdmonitionsSchema,
1415
} from "@docusaurus/utils-validation";
1516
import chalk from "chalk";
@@ -23,14 +24,17 @@ export const DEFAULT_OPTIONS: Omit<PluginOptions, "id" | "sidebarPath"> = {
2324
apiItemComponent: "@theme/ApiItem",
2425
remarkPlugins: [],
2526
rehypePlugins: [],
27+
recmaPlugins: [],
2628
beforeDefaultRemarkPlugins: [],
2729
beforeDefaultRehypePlugins: [],
2830
admonitions: true,
2931
sidebarCollapsible: true,
3032
sidebarCollapsed: true,
33+
onInlineTags: "warn",
34+
tags: undefined,
3135
};
3236

33-
export const OptionsSchema = Joi.object({
37+
export const OptionsSchema = Joi.object<PluginOptions>({
3438
path: Joi.string().default(DEFAULT_OPTIONS.path),
3539
routeBasePath: Joi.string()
3640
// '' not allowed, see https://github.com/facebook/docusaurus/issues/3374
@@ -42,6 +46,7 @@ export const OptionsSchema = Joi.object({
4246
apiItemComponent: Joi.string().default(DEFAULT_OPTIONS.apiItemComponent),
4347
remarkPlugins: RemarkPluginsSchema.default(DEFAULT_OPTIONS.remarkPlugins),
4448
rehypePlugins: RehypePluginsSchema.default(DEFAULT_OPTIONS.rehypePlugins),
49+
recmaPlugins: RecmaPluginsSchema.default(DEFAULT_OPTIONS.recmaPlugins),
4550
beforeDefaultRemarkPlugins: RemarkPluginsSchema.default(
4651
DEFAULT_OPTIONS.beforeDefaultRemarkPlugins
4752
),
@@ -51,6 +56,13 @@ export const OptionsSchema = Joi.object({
5156
admonitions: Joi.alternatives()
5257
.try(AdmonitionsSchema, Joi.boolean().invalid(true))
5358
.default(DEFAULT_OPTIONS.admonitions),
59+
onInlineTags: Joi.string()
60+
.equal("ignore", "log", "warn", "throw")
61+
.default(DEFAULT_OPTIONS.onInlineTags),
62+
tags: Joi.string()
63+
.disallow("")
64+
.allow(null, false)
65+
.default(() => DEFAULT_OPTIONS.tags),
5466
});
5567

5668
export function validateOptions({

‎packages/docusaurus-plugin-openapi/src/types.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* ========================================================================== */
77

88
import type { MDXOptions } from "@docusaurus/mdx-loader";
9+
import type { TagsPluginOptions } from "@docusaurus/utils";
910
import type { Request } from "postman-collection";
1011

1112
import {
@@ -20,7 +21,7 @@ export type {
2021
PropSidebar,
2122
PropSidebarItem,
2223
} from "@docusaurus/plugin-content-docs-types";
23-
export interface PluginOptions extends MDXOptions {
24+
export interface PluginOptions extends MDXOptions, TagsPluginOptions {
2425
id: string;
2526
path: string;
2627
routeBasePath: string;

‎packages/docusaurus-plugin-proxy/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"watch": "tsc --watch"
2222
},
2323
"devDependencies": {
24-
"@docusaurus/types": "^3.2.0",
24+
"@docusaurus/types": "^3.6.0",
2525
"@types/webpack-dev-server": "^4.7.2"
2626
},
2727
"engines": {

‎packages/docusaurus-preset-openapi/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@
2828
"watch": "tsc --watch"
2929
},
3030
"devDependencies": {
31-
"@docusaurus/types": "^3.2.0"
31+
"@docusaurus/types": "^3.6.0"
3232
},
3333
"dependencies": {
34-
"@docusaurus/preset-classic": "^3.2.0",
34+
"@docusaurus/preset-classic": "^3.6.0",
3535
"docusaurus-plugin-openapi": "^0.7.5",
3636
"docusaurus-plugin-proxy": "^0.7.5",
3737
"docusaurus-theme-openapi": "^0.7.5"

‎packages/docusaurus-template-openapi/template.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"write-heading-ids": "docusaurus write-heading-ids"
1616
},
1717
"dependencies": {
18-
"@docusaurus/core": "^3.2.0",
18+
"@docusaurus/core": "^3.6.0",
1919
"docusaurus-preset-openapi": "0.7.5",
2020
"@mdx-js/react": "^3.0.0",
2121
"clsx": "^1.2.1",

0 commit comments

Comments
 (0)