From cc93ebc64cf6d5d73128fea6e4beee4af3c24850 Mon Sep 17 00:00:00 2001 From: Julian Verkin Date: Wed, 24 Jul 2024 13:34:16 +0200 Subject: [PATCH] docs(plugin-content-docs): fix #10336 wrong default value for docRootComponent --- website/docs/api/plugins/plugin-content-docs.mdx | 2 +- .../version-3.0.1/api/plugins/plugin-content-docs.mdx | 6 ++++-- .../version-3.1.1/api/plugins/plugin-content-docs.mdx | 6 ++++-- .../version-3.2.1/api/plugins/plugin-content-docs.mdx | 2 +- .../version-3.3.2/api/plugins/plugin-content-docs.mdx | 2 +- .../version-3.4.0/api/plugins/plugin-content-docs.mdx | 2 +- 6 files changed, 12 insertions(+), 8 deletions(-) diff --git a/website/docs/api/plugins/plugin-content-docs.mdx b/website/docs/api/plugins/plugin-content-docs.mdx index 295d228c11ff..8f26354b8189 100644 --- a/website/docs/api/plugins/plugin-content-docs.mdx +++ b/website/docs/api/plugins/plugin-content-docs.mdx @@ -48,7 +48,7 @@ Accepted fields: | `numberPrefixParser` | boolean \| [PrefixParser](#PrefixParser) | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar/autogenerated#using-number-prefixes) | | `docsRootComponent` | `string` | `'@theme/DocsRoot'` | Parent component of all the docs plugin pages (including all versions). Stays mounted when navigation between docs pages and versions. | | `docVersionRootComponent` | `string` | `'@theme/DocVersionLayout'` | Parent component of all docs pages of an individual version (doc pages with sidebars, tags pages). Stays mounted when navigation between pages of that specific version. | -| `docRootComponent` | `string` | `'@theme/DocPage'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | +| `docRootComponent` | `string` | `'@theme/DocRoot'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | | `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. | | `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page | | `docTagDocListComponent` | `string` | `'@theme/DocTagDocListPage'` | Root component of the "docs containing tag X" page. | diff --git a/website/versioned_docs/version-3.0.1/api/plugins/plugin-content-docs.mdx b/website/versioned_docs/version-3.0.1/api/plugins/plugin-content-docs.mdx index 027b0c862aed..04a18ae26074 100644 --- a/website/versioned_docs/version-3.0.1/api/plugins/plugin-content-docs.mdx +++ b/website/versioned_docs/version-3.0.1/api/plugins/plugin-content-docs.mdx @@ -48,7 +48,7 @@ Accepted fields: | `numberPrefixParser` | boolean \| [PrefixParser](#PrefixParser) | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar/autogenerated#using-number-prefixes) | | `docsRootComponent` | `string` | `'@theme/DocsRoot'` | Parent component of all the docs plugin pages (including all versions). Stays mounted when navigation between docs pages and versions. | | `docVersionRootComponent` | `string` | `'@theme/DocVersionLayout'` | Parent component of all docs pages of an individual version (doc pages with sidebars, tags pages). Stays mounted when navigation between pages of that specific version. | -| `docRootComponent` | `string` | `'@theme/DocPage'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | +| `docRootComponent` | `string` | `'@theme/DocRoot'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | | `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. | | `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page | | `docTagDocListComponent` | `string` | `'@theme/DocTagDocListPage'` | Root component of the "docs containing tag X" page. | @@ -232,7 +232,9 @@ const config = { // No number prefix found return {numberPrefix: undefined, filename}; }, - docLayoutComponent: '@theme/DocPage', + docsRootComponent: '@theme/DocsRoot', + docVersionRootComponent: '@theme/DocVersionRoot', + docRootComponent: '@theme/DocRoot', docItemComponent: '@theme/DocItem', remarkPlugins: [require('./my-remark-plugin')], rehypePlugins: [], diff --git a/website/versioned_docs/version-3.1.1/api/plugins/plugin-content-docs.mdx b/website/versioned_docs/version-3.1.1/api/plugins/plugin-content-docs.mdx index 027b0c862aed..04a18ae26074 100644 --- a/website/versioned_docs/version-3.1.1/api/plugins/plugin-content-docs.mdx +++ b/website/versioned_docs/version-3.1.1/api/plugins/plugin-content-docs.mdx @@ -48,7 +48,7 @@ Accepted fields: | `numberPrefixParser` | boolean \| [PrefixParser](#PrefixParser) | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar/autogenerated#using-number-prefixes) | | `docsRootComponent` | `string` | `'@theme/DocsRoot'` | Parent component of all the docs plugin pages (including all versions). Stays mounted when navigation between docs pages and versions. | | `docVersionRootComponent` | `string` | `'@theme/DocVersionLayout'` | Parent component of all docs pages of an individual version (doc pages with sidebars, tags pages). Stays mounted when navigation between pages of that specific version. | -| `docRootComponent` | `string` | `'@theme/DocPage'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | +| `docRootComponent` | `string` | `'@theme/DocRoot'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | | `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. | | `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page | | `docTagDocListComponent` | `string` | `'@theme/DocTagDocListPage'` | Root component of the "docs containing tag X" page. | @@ -232,7 +232,9 @@ const config = { // No number prefix found return {numberPrefix: undefined, filename}; }, - docLayoutComponent: '@theme/DocPage', + docsRootComponent: '@theme/DocsRoot', + docVersionRootComponent: '@theme/DocVersionRoot', + docRootComponent: '@theme/DocRoot', docItemComponent: '@theme/DocItem', remarkPlugins: [require('./my-remark-plugin')], rehypePlugins: [], diff --git a/website/versioned_docs/version-3.2.1/api/plugins/plugin-content-docs.mdx b/website/versioned_docs/version-3.2.1/api/plugins/plugin-content-docs.mdx index 09ce59a60e5e..cd19041eb02d 100644 --- a/website/versioned_docs/version-3.2.1/api/plugins/plugin-content-docs.mdx +++ b/website/versioned_docs/version-3.2.1/api/plugins/plugin-content-docs.mdx @@ -48,7 +48,7 @@ Accepted fields: | `numberPrefixParser` | boolean \| [PrefixParser](#PrefixParser) | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar/autogenerated#using-number-prefixes) | | `docsRootComponent` | `string` | `'@theme/DocsRoot'` | Parent component of all the docs plugin pages (including all versions). Stays mounted when navigation between docs pages and versions. | | `docVersionRootComponent` | `string` | `'@theme/DocVersionLayout'` | Parent component of all docs pages of an individual version (doc pages with sidebars, tags pages). Stays mounted when navigation between pages of that specific version. | -| `docRootComponent` | `string` | `'@theme/DocPage'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | +| `docRootComponent` | `string` | `'@theme/DocRoot'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | | `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. | | `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page | | `docTagDocListComponent` | `string` | `'@theme/DocTagDocListPage'` | Root component of the "docs containing tag X" page. | diff --git a/website/versioned_docs/version-3.3.2/api/plugins/plugin-content-docs.mdx b/website/versioned_docs/version-3.3.2/api/plugins/plugin-content-docs.mdx index 09ce59a60e5e..cd19041eb02d 100644 --- a/website/versioned_docs/version-3.3.2/api/plugins/plugin-content-docs.mdx +++ b/website/versioned_docs/version-3.3.2/api/plugins/plugin-content-docs.mdx @@ -48,7 +48,7 @@ Accepted fields: | `numberPrefixParser` | boolean \| [PrefixParser](#PrefixParser) | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar/autogenerated#using-number-prefixes) | | `docsRootComponent` | `string` | `'@theme/DocsRoot'` | Parent component of all the docs plugin pages (including all versions). Stays mounted when navigation between docs pages and versions. | | `docVersionRootComponent` | `string` | `'@theme/DocVersionLayout'` | Parent component of all docs pages of an individual version (doc pages with sidebars, tags pages). Stays mounted when navigation between pages of that specific version. | -| `docRootComponent` | `string` | `'@theme/DocPage'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | +| `docRootComponent` | `string` | `'@theme/DocRoot'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | | `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. | | `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page | | `docTagDocListComponent` | `string` | `'@theme/DocTagDocListPage'` | Root component of the "docs containing tag X" page. | diff --git a/website/versioned_docs/version-3.4.0/api/plugins/plugin-content-docs.mdx b/website/versioned_docs/version-3.4.0/api/plugins/plugin-content-docs.mdx index 1a9dcc370758..7c6c4db8c41b 100644 --- a/website/versioned_docs/version-3.4.0/api/plugins/plugin-content-docs.mdx +++ b/website/versioned_docs/version-3.4.0/api/plugins/plugin-content-docs.mdx @@ -48,7 +48,7 @@ Accepted fields: | `numberPrefixParser` | boolean \| [PrefixParser](#PrefixParser) | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar/autogenerated#using-number-prefixes) | | `docsRootComponent` | `string` | `'@theme/DocsRoot'` | Parent component of all the docs plugin pages (including all versions). Stays mounted when navigation between docs pages and versions. | | `docVersionRootComponent` | `string` | `'@theme/DocVersionLayout'` | Parent component of all docs pages of an individual version (doc pages with sidebars, tags pages). Stays mounted when navigation between pages of that specific version. | -| `docRootComponent` | `string` | `'@theme/DocPage'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | +| `docRootComponent` | `string` | `'@theme/DocRoot'` | Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages. | | `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. | | `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page | | `docTagDocListComponent` | `string` | `'@theme/DocTagDocListPage'` | Root component of the "docs containing tag X" page. |