diff --git a/website/docs/api/plugins/plugin-content-blog.md b/website/docs/api/plugins/plugin-content-blog.md index 889679757b..58af14d1dd 100644 --- a/website/docs/api/plugins/plugin-content-blog.md +++ b/website/docs/api/plugins/plugin-content-blog.md @@ -29,17 +29,17 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `path` | `string` | `'blog'` | Path to the blog content directory on the filesystem, relative to site dir. | -| `editUrl` | string | EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | +| `editUrl` | string \| EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | | `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. | | `blogTitle` | `string` | `'Blog'` | Blog page title for better SEO. | | `blogDescription` | `string` | `'Blog'` | Blog page meta description for better SEO. | -| `blogSidebarCount` | number | 'ALL' | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable | +| `blogSidebarCount` | number \| 'ALL' | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable | | `blogSidebarTitle` | `string` | `'Recent posts'` | Title of the blog sidebar. | | `routeBasePath` | `string` | `'blog'` | URL route for the blog section of your site. **DO NOT** include a trailing slash. Use `/` to put the blog at root path. | | `archiveBasePath` | `string` | `'/archive'` | URL route for the archive blog section of your site. It is prepended to the `routeBasePath`. **DO NOT** include a trailing slash. | | `include` | `string[]` | `['**/*.{md,mdx}']` | Matching files will be included and processed. | | `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. | -| `postsPerPage` | number | 'ALL' | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. | +| `postsPerPage` | number \| 'ALL' | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. | | `blogListComponent` | `string` | `'@theme/BlogListPage'` | Root component of the blog listing page. | | `blogPostComponent` | `string` | `'@theme/BlogPostPage'` | Root component of each blog post page. | | `blogTagsListComponent` | `string` | `'@theme/BlogTagsListPage'` | Root component of the tags list page | @@ -52,7 +52,7 @@ Accepted fields: | `showReadingTime` | `boolean` | `true` | Show estimated reading time for the blog post. | | `authorsMapPath` | `string` | `'authors.yml'` | Path to the authors map file, relative to the blog content directory specified with `path`. Can also be a `json` file. | | `feedOptions` | _See below_ | `{type: ['rss', 'atom']}` | Blog feed. If undefined, no rss feed will be generated. | -| `feedOptions.type` | 'rss' | 'atom' | 'all' (or array of multiple options) | **Required** | Type of feed to be generated. | +| `feedOptions.type` | 'rss' \| 'atom' \| 'all' (or array of multiple options) | **Required** | Type of feed to be generated. | | `feedOptions.title` | `string` | `siteConfig.title` | Title of the feed. | | `feedOptions.description` | `string` | \`${siteConfig.title} Blog\` | Description of the feed. | | `feedOptions.copyright` | `string` | `undefined` | Copyright message. | diff --git a/website/docs/api/plugins/plugin-content-docs.md b/website/docs/api/plugins/plugin-content-docs.md index 50ccfd5fe5..59cae99b86 100644 --- a/website/docs/api/plugins/plugin-content-docs.md +++ b/website/docs/api/plugins/plugin-content-docs.md @@ -29,17 +29,17 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `path` | `string` | `'docs'` | Path to data on filesystem relative to site dir. | -| `editUrl` | string | EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | +| `editUrl` | string \| EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | | `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. | | `editCurrentVersion` | `boolean` | `false` | The edit URL will always target the current version doc instead of older versions. Ignored when `editUrl` is a function. | | `routeBasePath` | `string` | `'docs'` | URL route for the docs section of your site. **DO NOT** include a trailing slash. Use `/` for shipping docs without base path. | | `include` | `string[]` | `['**/*.{md,mdx}']` | Matching files will be included and processed. | | `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. | -| `sidebarPath` | false | string | `undefined` (creates autogenerated sidebar) | Path to sidebar configuration. | +| `sidebarPath` | false \| string | `undefined` (creates autogenerated sidebar) | Path to sidebar configuration. | | `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. See also [Collapsible categories](/docs/sidebar#collapsible-categories) | | `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. See also [Expanded categories by default](/docs/sidebar#expanded-categories-by-default) | | `sidebarItemsGenerator` | `SidebarGenerator` | _Omitted_ | Function used to replace the sidebar items of type `'autogenerated'` by real sidebar items (docs, categories, links...). See also [Customize the sidebar items generator](/docs/sidebar#customize-the-sidebar-items-generator) | -| `numberPrefixParser` | boolean | 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#using-number-prefixes) | +| `numberPrefixParser` | boolean \| 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#using-number-prefixes) | | `docLayoutComponent` | `string` | `'@theme/DocPage'` | Root Layout component of each doc page. | | `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. | | `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page | diff --git a/website/docs/api/themes/theme-configuration.md b/website/docs/api/themes/theme-configuration.md index 8b099bd1ac..c22cdbe652 100644 --- a/website/docs/api/themes/theme-configuration.md +++ b/website/docs/api/themes/theme-configuration.md @@ -20,7 +20,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | -| `defaultMode` | 'light' | 'dark' | `'light'` | The color mode when user first visits the site. | +| `defaultMode` | 'light' \| 'dark' | `'light'` | The color mode when user first visits the site. | | `disableSwitch` | `boolean` | `false` | Hides the switch in the navbar. Useful if you want to support a single color mode. | | `respectPrefersColorScheme` | `boolean` | `false` | Whether to use the `prefers-color-scheme` media-query, using user system preferences, instead of the hardcoded `defaultMode`. | | `switchConfig` | _See below_ | _See below_ | Dark/light switch icon options. | @@ -166,7 +166,7 @@ Accepted fields: | `logo` | _See below_ | `undefined` | Customization of the logo object. | | `items` | `NavbarItem[]` | `[]` | A list of navbar items. See specification below. | | `hideOnScroll` | `boolean` | `false` | Whether the navbar is hidden when the user scrolls down. | -| `style` | 'primary' | 'dark' | Same as theme | Sets the navbar style, ignoring the dark/light theme. | +| `style` | 'primary' \| 'dark' | Same as theme | Sets the navbar style, ignoring the dark/light theme. | @@ -269,7 +269,7 @@ Accepted fields: | `to` | `string` | **Required** | Client-side routing, used for navigating within the website. The baseUrl will be automatically prepended to this value. | | `href` | `string` | **Required** | A full-page navigation, used for navigating outside of the website. **Only one of `to` or `href` should be used.** | | `prependBaseUrlToHref` | `boolean` | `false` | Prepends the baseUrl to `href` values. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `activeBasePath` | `string` | `to` / `href` | To apply the active class styling on all routes starting with this path. This usually isn't necessary. | | `activeBaseRegex` | `string` | `undefined` | Alternative to `activeBasePath` if required. | | `className` | `string` | `''` | Custom CSS class (for styling any item). | @@ -326,7 +326,7 @@ Accepted fields: | --- | --- | --- | --- | | `label` | `string` | **Required** | The name to be shown for this item. | | `items` | [LinkLikeItem](#navbar-dropdown)[] | **Required** | The items to be contained in the dropdown. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | @@ -374,7 +374,7 @@ Accepted fields: | --- | --- | --- | --- | | `docId` | `string` | **Required** | The ID of the doc that this item links to. | | `label` | `string` | `docId` | The name to be shown for this item. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc belongs to. | @@ -412,7 +412,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `dropdownItemsBefore` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the beginning of the dropdown. | | `dropdownItemsAfter` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the end of the dropdown. | | `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc versioning belongs to. | @@ -453,7 +453,7 @@ Accepted fields: | --- | --- | --- | --- | | `label` | `string` | The active/latest version label. | The name to be shown for this item. | | `to` | `string` | The active/latest version. | The internal link that this item points to. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc versioning belongs to. | @@ -491,7 +491,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `dropdownItemsBefore` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the beginning of the dropdown. | | `dropdownItemsAfter` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the end of the dropdown. | @@ -532,7 +532,7 @@ However, with this special navbar item type, you can change the default location | Name | Type | Default | Description | | --- | --- | --- | --- | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | @@ -655,7 +655,7 @@ Accepted fields: | --- | --- | --- | --- | | `logo` | `Logo` | `undefined` | Customization of the logo object. See [Navbar logo](#navbar-logo) for details. | | `copyright` | `string` | `undefined` | The copyright message to be displayed at the bottom. | -| `style` | 'dark' | 'light' | `'light'` | The color theme of the footer component. | +| `style` | 'dark' \| 'light' | `'light'` | The color theme of the footer component. | | `items` | `FooterItem[]` | `[]` | The link groups to be present. | diff --git a/website/versioned_docs/version-2.0.0-beta.5/api/plugins/plugin-content-blog.md b/website/versioned_docs/version-2.0.0-beta.5/api/plugins/plugin-content-blog.md index 26ef631a62..58fd68f9c2 100644 --- a/website/versioned_docs/version-2.0.0-beta.5/api/plugins/plugin-content-blog.md +++ b/website/versioned_docs/version-2.0.0-beta.5/api/plugins/plugin-content-blog.md @@ -29,16 +29,16 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `path` | `string` | `'blog'` | Path to the blog content directory on the filesystem, relative to site dir. | -| `editUrl` | string | EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | +| `editUrl` | string \| EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | | `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. | | `blogTitle` | `string` | `'Blog'` | Blog page title for better SEO. | | `blogDescription` | `string` | `'Blog'` | Blog page meta description for better SEO. | -| `blogSidebarCount` | number | 'ALL' | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable | +| `blogSidebarCount` | number \| 'ALL' | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable | | `blogSidebarTitle` | `string` | `'Recent posts'` | Title of the blog sidebar. | | `routeBasePath` | `string` | `'blog'` | URL route for the blog section of your site. **DO NOT** include a trailing slash. Use `/` to put the blog at root path. | | `include` | `string[]` | `['**/*.{md,mdx}']` | Matching files will be included and processed. | | `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. | -| `postsPerPage` | number | 'ALL' | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. | +| `postsPerPage` | number \| 'ALL' | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. | | `blogListComponent` | `string` | `'@theme/BlogListPage'` | Root component of the blog listing page. | | `blogPostComponent` | `string` | `'@theme/BlogPostPage'` | Root component of each blog post page. | | `blogTagsListComponent` | `string` | `'@theme/BlogTagsListPage'` | Root component of the tags list page | @@ -51,7 +51,7 @@ Accepted fields: | `showReadingTime` | `boolean` | `true` | Show estimated reading time for the blog post. | | `authorsMapPath` | `string` | `'authors.yml'` | Path to the authors map file, relative to the blog content directory specified with `path`. Can also be a `json` file. | | `feedOptions` | _See below_ | `{type: ['rss', 'atom']}` | Blog feed. If undefined, no rss feed will be generated. | -| `feedOptions.type` | 'rss' | 'atom' | 'all' (or array of multiple options) | **Required** | Type of feed to be generated. | +| `feedOptions.type` | 'rss' \| 'atom' \| 'all' (or array of multiple options) | **Required** | Type of feed to be generated. | | `feedOptions.title` | `string` | `siteConfig.title` | Title of the feed. | | `feedOptions.description` | `string` | \`${siteConfig.title} Blog\` | Description of the feed. | | `feedOptions.copyright` | `string` | `undefined` | Copyright message. | diff --git a/website/versioned_docs/version-2.0.0-beta.5/api/plugins/plugin-content-docs.md b/website/versioned_docs/version-2.0.0-beta.5/api/plugins/plugin-content-docs.md index 800526ce47..f7fa8483f3 100644 --- a/website/versioned_docs/version-2.0.0-beta.5/api/plugins/plugin-content-docs.md +++ b/website/versioned_docs/version-2.0.0-beta.5/api/plugins/plugin-content-docs.md @@ -29,17 +29,17 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `path` | `string` | `'docs'` | Path to data on filesystem relative to site dir. | -| `editUrl` | string | EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | +| `editUrl` | string \| EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | | `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. | | `editCurrentVersion` | `boolean` | `false` | The edit URL will always target the current version doc instead of older versions. Ignored when `editUrl` is a function. | | `routeBasePath` | `string` | `'docs'` | URL route for the docs section of your site. **DO NOT** include a trailing slash. Use `/` for shipping docs without base path. | | `include` | `string[]` | `['**/*.{md,mdx}']` | Matching files will be included and processed. | | `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. | -| `sidebarPath` | false | string | `undefined` (creates autogenerated sidebar) | Path to sidebar configuration. | +| `sidebarPath` | false \| string | `undefined` (creates autogenerated sidebar) | Path to sidebar configuration. | | `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. See also [Collapsible categories](/docs/sidebar#collapsible-categories) | | `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. See also [Expanded categories by default](/docs/sidebar#expanded-categories-by-default) | | `sidebarItemsGenerator` | `SidebarGenerator` | _Omitted_ | Function used to replace the sidebar items of type `'autogenerated'` by real sidebar items (docs, categories, links...). See also [Customize the sidebar items generator](/docs/sidebar#customize-the-sidebar-items-generator) | -| `numberPrefixParser` | boolean | 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#using-number-prefixes) | +| `numberPrefixParser` | boolean \| 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#using-number-prefixes) | | `docLayoutComponent` | `string` | `'@theme/DocPage'` | Root Layout component of each doc page. | | `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. | | `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page | diff --git a/website/versioned_docs/version-2.0.0-beta.5/api/themes/theme-configuration.md b/website/versioned_docs/version-2.0.0-beta.5/api/themes/theme-configuration.md index 8b099bd1ac..c22cdbe652 100644 --- a/website/versioned_docs/version-2.0.0-beta.5/api/themes/theme-configuration.md +++ b/website/versioned_docs/version-2.0.0-beta.5/api/themes/theme-configuration.md @@ -20,7 +20,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | -| `defaultMode` | 'light' | 'dark' | `'light'` | The color mode when user first visits the site. | +| `defaultMode` | 'light' \| 'dark' | `'light'` | The color mode when user first visits the site. | | `disableSwitch` | `boolean` | `false` | Hides the switch in the navbar. Useful if you want to support a single color mode. | | `respectPrefersColorScheme` | `boolean` | `false` | Whether to use the `prefers-color-scheme` media-query, using user system preferences, instead of the hardcoded `defaultMode`. | | `switchConfig` | _See below_ | _See below_ | Dark/light switch icon options. | @@ -166,7 +166,7 @@ Accepted fields: | `logo` | _See below_ | `undefined` | Customization of the logo object. | | `items` | `NavbarItem[]` | `[]` | A list of navbar items. See specification below. | | `hideOnScroll` | `boolean` | `false` | Whether the navbar is hidden when the user scrolls down. | -| `style` | 'primary' | 'dark' | Same as theme | Sets the navbar style, ignoring the dark/light theme. | +| `style` | 'primary' \| 'dark' | Same as theme | Sets the navbar style, ignoring the dark/light theme. | @@ -269,7 +269,7 @@ Accepted fields: | `to` | `string` | **Required** | Client-side routing, used for navigating within the website. The baseUrl will be automatically prepended to this value. | | `href` | `string` | **Required** | A full-page navigation, used for navigating outside of the website. **Only one of `to` or `href` should be used.** | | `prependBaseUrlToHref` | `boolean` | `false` | Prepends the baseUrl to `href` values. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `activeBasePath` | `string` | `to` / `href` | To apply the active class styling on all routes starting with this path. This usually isn't necessary. | | `activeBaseRegex` | `string` | `undefined` | Alternative to `activeBasePath` if required. | | `className` | `string` | `''` | Custom CSS class (for styling any item). | @@ -326,7 +326,7 @@ Accepted fields: | --- | --- | --- | --- | | `label` | `string` | **Required** | The name to be shown for this item. | | `items` | [LinkLikeItem](#navbar-dropdown)[] | **Required** | The items to be contained in the dropdown. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | @@ -374,7 +374,7 @@ Accepted fields: | --- | --- | --- | --- | | `docId` | `string` | **Required** | The ID of the doc that this item links to. | | `label` | `string` | `docId` | The name to be shown for this item. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc belongs to. | @@ -412,7 +412,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `dropdownItemsBefore` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the beginning of the dropdown. | | `dropdownItemsAfter` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the end of the dropdown. | | `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc versioning belongs to. | @@ -453,7 +453,7 @@ Accepted fields: | --- | --- | --- | --- | | `label` | `string` | The active/latest version label. | The name to be shown for this item. | | `to` | `string` | The active/latest version. | The internal link that this item points to. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc versioning belongs to. | @@ -491,7 +491,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `dropdownItemsBefore` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the beginning of the dropdown. | | `dropdownItemsAfter` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the end of the dropdown. | @@ -532,7 +532,7 @@ However, with this special navbar item type, you can change the default location | Name | Type | Default | Description | | --- | --- | --- | --- | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | @@ -655,7 +655,7 @@ Accepted fields: | --- | --- | --- | --- | | `logo` | `Logo` | `undefined` | Customization of the logo object. See [Navbar logo](#navbar-logo) for details. | | `copyright` | `string` | `undefined` | The copyright message to be displayed at the bottom. | -| `style` | 'dark' | 'light' | `'light'` | The color theme of the footer component. | +| `style` | 'dark' \| 'light' | `'light'` | The color theme of the footer component. | | `items` | `FooterItem[]` | `[]` | The link groups to be present. | diff --git a/website/versioned_docs/version-2.0.0-beta.6/api/plugins/plugin-content-blog.md b/website/versioned_docs/version-2.0.0-beta.6/api/plugins/plugin-content-blog.md index 889679757b..58af14d1dd 100644 --- a/website/versioned_docs/version-2.0.0-beta.6/api/plugins/plugin-content-blog.md +++ b/website/versioned_docs/version-2.0.0-beta.6/api/plugins/plugin-content-blog.md @@ -29,17 +29,17 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `path` | `string` | `'blog'` | Path to the blog content directory on the filesystem, relative to site dir. | -| `editUrl` | string | EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | +| `editUrl` | string \| EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | | `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. | | `blogTitle` | `string` | `'Blog'` | Blog page title for better SEO. | | `blogDescription` | `string` | `'Blog'` | Blog page meta description for better SEO. | -| `blogSidebarCount` | number | 'ALL' | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable | +| `blogSidebarCount` | number \| 'ALL' | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable | | `blogSidebarTitle` | `string` | `'Recent posts'` | Title of the blog sidebar. | | `routeBasePath` | `string` | `'blog'` | URL route for the blog section of your site. **DO NOT** include a trailing slash. Use `/` to put the blog at root path. | | `archiveBasePath` | `string` | `'/archive'` | URL route for the archive blog section of your site. It is prepended to the `routeBasePath`. **DO NOT** include a trailing slash. | | `include` | `string[]` | `['**/*.{md,mdx}']` | Matching files will be included and processed. | | `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. | -| `postsPerPage` | number | 'ALL' | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. | +| `postsPerPage` | number \| 'ALL' | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. | | `blogListComponent` | `string` | `'@theme/BlogListPage'` | Root component of the blog listing page. | | `blogPostComponent` | `string` | `'@theme/BlogPostPage'` | Root component of each blog post page. | | `blogTagsListComponent` | `string` | `'@theme/BlogTagsListPage'` | Root component of the tags list page | @@ -52,7 +52,7 @@ Accepted fields: | `showReadingTime` | `boolean` | `true` | Show estimated reading time for the blog post. | | `authorsMapPath` | `string` | `'authors.yml'` | Path to the authors map file, relative to the blog content directory specified with `path`. Can also be a `json` file. | | `feedOptions` | _See below_ | `{type: ['rss', 'atom']}` | Blog feed. If undefined, no rss feed will be generated. | -| `feedOptions.type` | 'rss' | 'atom' | 'all' (or array of multiple options) | **Required** | Type of feed to be generated. | +| `feedOptions.type` | 'rss' \| 'atom' \| 'all' (or array of multiple options) | **Required** | Type of feed to be generated. | | `feedOptions.title` | `string` | `siteConfig.title` | Title of the feed. | | `feedOptions.description` | `string` | \`${siteConfig.title} Blog\` | Description of the feed. | | `feedOptions.copyright` | `string` | `undefined` | Copyright message. | diff --git a/website/versioned_docs/version-2.0.0-beta.6/api/plugins/plugin-content-docs.md b/website/versioned_docs/version-2.0.0-beta.6/api/plugins/plugin-content-docs.md index 50ccfd5fe5..59cae99b86 100644 --- a/website/versioned_docs/version-2.0.0-beta.6/api/plugins/plugin-content-docs.md +++ b/website/versioned_docs/version-2.0.0-beta.6/api/plugins/plugin-content-docs.md @@ -29,17 +29,17 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `path` | `string` | `'docs'` | Path to data on filesystem relative to site dir. | -| `editUrl` | string | EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | +| `editUrl` | string \| EditUrlFunction | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. | | `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. | | `editCurrentVersion` | `boolean` | `false` | The edit URL will always target the current version doc instead of older versions. Ignored when `editUrl` is a function. | | `routeBasePath` | `string` | `'docs'` | URL route for the docs section of your site. **DO NOT** include a trailing slash. Use `/` for shipping docs without base path. | | `include` | `string[]` | `['**/*.{md,mdx}']` | Matching files will be included and processed. | | `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. | -| `sidebarPath` | false | string | `undefined` (creates autogenerated sidebar) | Path to sidebar configuration. | +| `sidebarPath` | false \| string | `undefined` (creates autogenerated sidebar) | Path to sidebar configuration. | | `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. See also [Collapsible categories](/docs/sidebar#collapsible-categories) | | `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. See also [Expanded categories by default](/docs/sidebar#expanded-categories-by-default) | | `sidebarItemsGenerator` | `SidebarGenerator` | _Omitted_ | Function used to replace the sidebar items of type `'autogenerated'` by real sidebar items (docs, categories, links...). See also [Customize the sidebar items generator](/docs/sidebar#customize-the-sidebar-items-generator) | -| `numberPrefixParser` | boolean | 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#using-number-prefixes) | +| `numberPrefixParser` | boolean \| 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#using-number-prefixes) | | `docLayoutComponent` | `string` | `'@theme/DocPage'` | Root Layout component of each doc page. | | `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. | | `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page | diff --git a/website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md b/website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md index 8b099bd1ac..c22cdbe652 100644 --- a/website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md +++ b/website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md @@ -20,7 +20,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | -| `defaultMode` | 'light' | 'dark' | `'light'` | The color mode when user first visits the site. | +| `defaultMode` | 'light' \| 'dark' | `'light'` | The color mode when user first visits the site. | | `disableSwitch` | `boolean` | `false` | Hides the switch in the navbar. Useful if you want to support a single color mode. | | `respectPrefersColorScheme` | `boolean` | `false` | Whether to use the `prefers-color-scheme` media-query, using user system preferences, instead of the hardcoded `defaultMode`. | | `switchConfig` | _See below_ | _See below_ | Dark/light switch icon options. | @@ -166,7 +166,7 @@ Accepted fields: | `logo` | _See below_ | `undefined` | Customization of the logo object. | | `items` | `NavbarItem[]` | `[]` | A list of navbar items. See specification below. | | `hideOnScroll` | `boolean` | `false` | Whether the navbar is hidden when the user scrolls down. | -| `style` | 'primary' | 'dark' | Same as theme | Sets the navbar style, ignoring the dark/light theme. | +| `style` | 'primary' \| 'dark' | Same as theme | Sets the navbar style, ignoring the dark/light theme. | @@ -269,7 +269,7 @@ Accepted fields: | `to` | `string` | **Required** | Client-side routing, used for navigating within the website. The baseUrl will be automatically prepended to this value. | | `href` | `string` | **Required** | A full-page navigation, used for navigating outside of the website. **Only one of `to` or `href` should be used.** | | `prependBaseUrlToHref` | `boolean` | `false` | Prepends the baseUrl to `href` values. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `activeBasePath` | `string` | `to` / `href` | To apply the active class styling on all routes starting with this path. This usually isn't necessary. | | `activeBaseRegex` | `string` | `undefined` | Alternative to `activeBasePath` if required. | | `className` | `string` | `''` | Custom CSS class (for styling any item). | @@ -326,7 +326,7 @@ Accepted fields: | --- | --- | --- | --- | | `label` | `string` | **Required** | The name to be shown for this item. | | `items` | [LinkLikeItem](#navbar-dropdown)[] | **Required** | The items to be contained in the dropdown. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | @@ -374,7 +374,7 @@ Accepted fields: | --- | --- | --- | --- | | `docId` | `string` | **Required** | The ID of the doc that this item links to. | | `label` | `string` | `docId` | The name to be shown for this item. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc belongs to. | @@ -412,7 +412,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `dropdownItemsBefore` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the beginning of the dropdown. | | `dropdownItemsAfter` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the end of the dropdown. | | `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc versioning belongs to. | @@ -453,7 +453,7 @@ Accepted fields: | --- | --- | --- | --- | | `label` | `string` | The active/latest version label. | The name to be shown for this item. | | `to` | `string` | The active/latest version. | The internal link that this item points to. | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc versioning belongs to. | @@ -491,7 +491,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | | `dropdownItemsBefore` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the beginning of the dropdown. | | `dropdownItemsAfter` | [LinkLikeItem](#navbar-dropdown)[] | `[]` | Add additional dropdown items at the end of the dropdown. | @@ -532,7 +532,7 @@ However, with this special navbar item type, you can change the default location | Name | Type | Default | Description | | --- | --- | --- | --- | -| `position` | 'left' | 'right' | `'left'` | The side of the navbar this item should appear on. | +| `position` | 'left' \| 'right' | `'left'` | The side of the navbar this item should appear on. | @@ -655,7 +655,7 @@ Accepted fields: | --- | --- | --- | --- | | `logo` | `Logo` | `undefined` | Customization of the logo object. See [Navbar logo](#navbar-logo) for details. | | `copyright` | `string` | `undefined` | The copyright message to be displayed at the bottom. | -| `style` | 'dark' | 'light' | `'light'` | The color theme of the footer component. | +| `style` | 'dark' \| 'light' | `'light'` | The color theme of the footer component. | | `items` | `FooterItem[]` | `[]` | The link groups to be present. |