From f4e3ac59219e39557546cd2323afab3c1e90d8f8 Mon Sep 17 00:00:00 2001 From: fxpby Date: Mon, 13 Mar 2023 00:04:12 +0800 Subject: [PATCH] docs: add description for themeConfig.footer fields copyright --- website/docs/api/themes/theme-configuration.mdx | 2 +- .../version-2.0.1/api/themes/theme-configuration.mdx | 2 +- .../version-2.1.0/api/themes/theme-configuration.mdx | 2 +- .../version-2.2.0/api/themes/theme-configuration.mdx | 2 +- .../version-2.3.1/api/themes/theme-configuration.mdx | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/website/docs/api/themes/theme-configuration.mdx b/website/docs/api/themes/theme-configuration.mdx index 6b6ff4fbfcc2..e718c9adf473 100644 --- a/website/docs/api/themes/theme-configuration.mdx +++ b/website/docs/api/themes/theme-configuration.mdx @@ -846,7 +846,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `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. | +| `copyright` | `string` | `undefined` | The copyright message to be displayed at the bottom, also supports custom HTML. | | `style` | 'dark' \| 'light' | `'light'` | The color theme of the footer component. | | `links` | (Column \| FooterLink)[] | `[]` | The link groups to be present. | diff --git a/website/versioned_docs/version-2.0.1/api/themes/theme-configuration.mdx b/website/versioned_docs/version-2.0.1/api/themes/theme-configuration.mdx index 6b6ff4fbfcc2..e718c9adf473 100644 --- a/website/versioned_docs/version-2.0.1/api/themes/theme-configuration.mdx +++ b/website/versioned_docs/version-2.0.1/api/themes/theme-configuration.mdx @@ -846,7 +846,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `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. | +| `copyright` | `string` | `undefined` | The copyright message to be displayed at the bottom, also supports custom HTML. | | `style` | 'dark' \| 'light' | `'light'` | The color theme of the footer component. | | `links` | (Column \| FooterLink)[] | `[]` | The link groups to be present. | diff --git a/website/versioned_docs/version-2.1.0/api/themes/theme-configuration.mdx b/website/versioned_docs/version-2.1.0/api/themes/theme-configuration.mdx index 6b6ff4fbfcc2..e718c9adf473 100644 --- a/website/versioned_docs/version-2.1.0/api/themes/theme-configuration.mdx +++ b/website/versioned_docs/version-2.1.0/api/themes/theme-configuration.mdx @@ -846,7 +846,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `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. | +| `copyright` | `string` | `undefined` | The copyright message to be displayed at the bottom, also supports custom HTML. | | `style` | 'dark' \| 'light' | `'light'` | The color theme of the footer component. | | `links` | (Column \| FooterLink)[] | `[]` | The link groups to be present. | diff --git a/website/versioned_docs/version-2.2.0/api/themes/theme-configuration.mdx b/website/versioned_docs/version-2.2.0/api/themes/theme-configuration.mdx index 6b6ff4fbfcc2..e718c9adf473 100644 --- a/website/versioned_docs/version-2.2.0/api/themes/theme-configuration.mdx +++ b/website/versioned_docs/version-2.2.0/api/themes/theme-configuration.mdx @@ -846,7 +846,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `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. | +| `copyright` | `string` | `undefined` | The copyright message to be displayed at the bottom, also supports custom HTML. | | `style` | 'dark' \| 'light' | `'light'` | The color theme of the footer component. | | `links` | (Column \| FooterLink)[] | `[]` | The link groups to be present. | diff --git a/website/versioned_docs/version-2.3.1/api/themes/theme-configuration.mdx b/website/versioned_docs/version-2.3.1/api/themes/theme-configuration.mdx index 6b6ff4fbfcc2..e718c9adf473 100644 --- a/website/versioned_docs/version-2.3.1/api/themes/theme-configuration.mdx +++ b/website/versioned_docs/version-2.3.1/api/themes/theme-configuration.mdx @@ -846,7 +846,7 @@ Accepted fields: | Name | Type | Default | Description | | --- | --- | --- | --- | | `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. | +| `copyright` | `string` | `undefined` | The copyright message to be displayed at the bottom, also supports custom HTML. | | `style` | 'dark' \| 'light' | `'light'` | The color theme of the footer component. | | `links` | (Column \| FooterLink)[] | `[]` | The link groups to be present. |