docLayoutComponent is not allowed

[htessaro]

Scenario

I'm trying to use the plugging for the first time.
I followed the guide on the README, using what I believe would be the simplest implementation.

Problem

I can't generate the API pages.

When I run yarn docusaurus gen-api-docs all I receive the following error:

yarn docusaurus gen-api-docs all
yarn run v1.22.21
$ docusaurus gen-api-docs all
node:internal/process/esm_loader:40
      internalBinding('errors').triggerUncaughtException(
                                ^

[Error [ValidationError]: "docLayoutComponent" is not allowed] {
  _original: {
    routeBasePath: '/',
    sidebarPath: 'C:\\Users\\heito\\OneDrive\\Write-Choice\\bucketeer-docs\\sidebars.js',
    editUrl: 'https://github.com/bucketeer-io/bucketeer-docs/tree/master',
    showLastUpdateTime: true,
    docLayoutComponent: '@theme/DocPage',
    docItemComponent: '@theme/ApiItem'
  },
  details: [
    {
      message: '"docLayoutComponent" is not allowed',
      path: [ 'docLayoutComponent' ],
      type: 'object.unknown',
      context: {
        child: 'docLayoutComponent',
        label: 'docLayoutComponent',
        value: '@theme/DocPage',
        key: 'docLayoutComponent'
      }
    }
  ]
}

Node.js v20.10.0
error Command failed with exit code 1.

My configurations:

• package.json

{
  "name": "docs",
  "version": "0.0.0",
  "private": true,
  "scripts": {
    "docusaurus": "docusaurus",
    "start": "docusaurus start",
    "build": "docusaurus build",
    "swizzle": "docusaurus swizzle",
    "deploy": "docusaurus deploy",
    "clear": "docusaurus clear",
    "serve": "docusaurus serve",
    "write-translations": "docusaurus write-translations",
    "write-heading-ids": "docusaurus write-heading-ids"
  },
  "dependencies": {
    "@docusaurus/core": "^3.0.1",
    "@docusaurus/plugin-google-gtag": "^3.4.0",
    "@docusaurus/preset-classic": "^3.0.1",
    "@easyops-cn/docusaurus-search-local": "^0.44.2",
    "@mdx-js/react": "^3.0.0",
    "@scalar/docusaurus": "0.4.15",
    "clsx": "^1.2.1",
    "docusaurus-plugin-image-zoom": "^2.0.0",
    "docusaurus-plugin-openapi-docs": "^2.1.3",
    "docusaurus-theme-openapi-docs": "^2.1.3",
    "prism-react-renderer": "^2.1.0",
    "react": "^18.2.0",
    "react-dom": "^18.2.0"
  },
  "devDependencies": {
    "@docusaurus/module-type-aliases": "^3.0.1",
    "@docusaurus/types": "^3.0.1"
  },
  "browserslist": {
    "production": [
      ">0.5%",
      "not dead",
      "not op_mini all"
    ],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  },
  "engines": {
    "node": ">=18.0"
  }
}

• docusaurus.config.js

/** @type {import('@docusaurus/types').Config} */
const config = {
  themes: [
    [
      require.resolve("@easyops-cn/docusaurus-search-local"),
      ({
        hashed: true,
        searchResultContextMaxLength: 100,
        indexBlog: false,
        language: ["en"],
      }),
    ],
    "docusaurus-theme-openapi-docs"
  ],

presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          routeBasePath: '/',
          sidebarPath: require.resolve('./sidebars.js'),
          editUrl: '<my-URL>',
          showLastUpdateTime: true,
          docLayoutComponent: "@theme/DocPage",
          docItemComponent: "@theme/ApiItem" // derived from docusaurus-theme-openapi-docs
        },
        blog: false,
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],

plugins: [
    [
      'docusaurus-plugin-openapi-docs',
      {
        id: "api", // plugin id
        docsPluginId: "classic", // id of plugin-content-docs or preset for rendering docs
        config: {
          service: {
            specPath: "openapi/service.json",
            outputDir: "api/service",
            sidebarOptions: {
              groupPathsBy: "tag",
            },
          }
        }
      },
    ]
  ],

[AnnaWinnick]

@htessaro Did you ever figure this out? I'm getting the same error when I try to use a custom markdown generator with the createSchemaPageMD config field and I'm curious to see if it's a similar fix.

[htessaro]

Not really. We just started a new project from scratch, and it worked.