From cd7875bf84b7820552f9c71a187252d8e44c14e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Fri, 7 Feb 2025 16:57:23 +0100 Subject: [PATCH] docs: move docs of `frontMatter.title_meta` from docs to blog plugin (#10916) --- website/docs/api/plugins/plugin-content-blog.mdx | 1 + website/docs/api/plugins/plugin-content-docs.mdx | 1 - .../version-3.6.3/api/plugins/plugin-content-blog.mdx | 1 + .../version-3.6.3/api/plugins/plugin-content-docs.mdx | 1 - .../version-3.7.0/api/plugins/plugin-content-blog.mdx | 1 + .../version-3.7.0/api/plugins/plugin-content-docs.mdx | 1 - 6 files changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/api/plugins/plugin-content-blog.mdx b/website/docs/api/plugins/plugin-content-blog.mdx index 4445f49a1e..1a1703b7c4 100644 --- a/website/docs/api/plugins/plugin-content-blog.mdx +++ b/website/docs/api/plugins/plugin-content-blog.mdx @@ -250,6 +250,7 @@ Accepted fields: | `author_image_url` | `string` | `undefined` | ⚠️ Prefer using `authors`. The URL to the author's thumbnail image. | | `author_title` | `string` | `undefined` | ⚠️ Prefer using `authors`. A description of the author. | | `title` | `string` | Markdown title | The blog post title. | +| `title_meta` | `string` | `frontMatter.title` | The blog post SEO metadata title, used in `` for `` and `og:title`. Permits to override `title` when the displayed title and SEO title should be different. | | `sidebar_label` | `string` | `title` | A custom label for the blog sidebar, replacing the default one (`title`). | | `date` | `string` | File name or file creation time | The blog post creation date. If not specified, this can be extracted from the file or folder name, e.g, `2021-04-15-blog-post.mdx`, `2021-04-15-blog-post/index.mdx`, `2021/04/15/blog-post.mdx`. Otherwise, it is the Markdown file creation time. | | `tags` | `Tag[]` | `undefined` | A list of strings or objects of two string fields `label` and `permalink` to tag to your post. Strings can be a reference to keys of a [tags file](#tags-file) (usually `tags.yml`) | diff --git a/website/docs/api/plugins/plugin-content-docs.mdx b/website/docs/api/plugins/plugin-content-docs.mdx index b14df36827..fa9ddbf53e 100644 --- a/website/docs/api/plugins/plugin-content-docs.mdx +++ b/website/docs/api/plugins/plugin-content-docs.mdx @@ -278,7 +278,6 @@ Accepted fields: | --- | --- | --- | --- | | `id` | `string` | file path (including folders, without the extension) | A unique document ID. | | `title` | `string` | Markdown title or `id` | The text title of your document. Used for the page metadata and as a fallback value in multiple places (sidebar, next/previous buttons...). Automatically added at the top of your doc if it does not contain any Markdown title. | -| `title_meta` | `string` | `frontMatter.title` | The SEO metadata title of your document used in `<head>` for `<title>` and `og:title`. Permits to override `frontMatter.title` when the displayed title and SEO title should be different. | | `pagination_label` | `string` | `sidebar_label` or `title` | The text used in the document next/previous buttons for this document. | | `sidebar_label` | `string` | `title` | The text shown in the document sidebar for this document. | | `sidebar_position` | `number` | Default ordering | Controls the position of a doc inside the generated sidebar slice when using `autogenerated` sidebar items. See also [Autogenerated sidebar metadata](/docs/sidebar/autogenerated#autogenerated-sidebar-metadata). | diff --git a/website/versioned_docs/version-3.6.3/api/plugins/plugin-content-blog.mdx b/website/versioned_docs/version-3.6.3/api/plugins/plugin-content-blog.mdx index 64da72ee3c..4307cd4069 100644 --- a/website/versioned_docs/version-3.6.3/api/plugins/plugin-content-blog.mdx +++ b/website/versioned_docs/version-3.6.3/api/plugins/plugin-content-blog.mdx @@ -250,6 +250,7 @@ Accepted fields: | `author_image_url` | `string` | `undefined` | ⚠️ Prefer using `authors`. The URL to the author's thumbnail image. | | `author_title` | `string` | `undefined` | ⚠️ Prefer using `authors`. A description of the author. | | `title` | `string` | Markdown title | The blog post title. | +| `title_meta` | `string` | `frontMatter.title` | The blog post SEO metadata title, used in `<head>` for `<title>` and `og:title`. Permits to override `title` when the displayed title and SEO title should be different. | | `date` | `string` | File name or file creation time | The blog post creation date. If not specified, this can be extracted from the file or folder name, e.g, `2021-04-15-blog-post.mdx`, `2021-04-15-blog-post/index.mdx`, `2021/04/15/blog-post.mdx`. Otherwise, it is the Markdown file creation time. | | `tags` | `Tag[]` | `undefined` | A list of strings or objects of two string fields `label` and `permalink` to tag to your post. Strings can be a reference to keys of a [tags file](#tags-file) (usually `tags.yml`) | | `draft` | `boolean` | `false` | Draft blog posts will only be available during development. | diff --git a/website/versioned_docs/version-3.6.3/api/plugins/plugin-content-docs.mdx b/website/versioned_docs/version-3.6.3/api/plugins/plugin-content-docs.mdx index b14df36827..fa9ddbf53e 100644 --- a/website/versioned_docs/version-3.6.3/api/plugins/plugin-content-docs.mdx +++ b/website/versioned_docs/version-3.6.3/api/plugins/plugin-content-docs.mdx @@ -278,7 +278,6 @@ Accepted fields: | --- | --- | --- | --- | | `id` | `string` | file path (including folders, without the extension) | A unique document ID. | | `title` | `string` | Markdown title or `id` | The text title of your document. Used for the page metadata and as a fallback value in multiple places (sidebar, next/previous buttons...). Automatically added at the top of your doc if it does not contain any Markdown title. | -| `title_meta` | `string` | `frontMatter.title` | The SEO metadata title of your document used in `<head>` for `<title>` and `og:title`. Permits to override `frontMatter.title` when the displayed title and SEO title should be different. | | `pagination_label` | `string` | `sidebar_label` or `title` | The text used in the document next/previous buttons for this document. | | `sidebar_label` | `string` | `title` | The text shown in the document sidebar for this document. | | `sidebar_position` | `number` | Default ordering | Controls the position of a doc inside the generated sidebar slice when using `autogenerated` sidebar items. See also [Autogenerated sidebar metadata](/docs/sidebar/autogenerated#autogenerated-sidebar-metadata). | diff --git a/website/versioned_docs/version-3.7.0/api/plugins/plugin-content-blog.mdx b/website/versioned_docs/version-3.7.0/api/plugins/plugin-content-blog.mdx index 4445f49a1e..1a1703b7c4 100644 --- a/website/versioned_docs/version-3.7.0/api/plugins/plugin-content-blog.mdx +++ b/website/versioned_docs/version-3.7.0/api/plugins/plugin-content-blog.mdx @@ -250,6 +250,7 @@ Accepted fields: | `author_image_url` | `string` | `undefined` | ⚠️ Prefer using `authors`. The URL to the author's thumbnail image. | | `author_title` | `string` | `undefined` | ⚠️ Prefer using `authors`. A description of the author. | | `title` | `string` | Markdown title | The blog post title. | +| `title_meta` | `string` | `frontMatter.title` | The blog post SEO metadata title, used in `<head>` for `<title>` and `og:title`. Permits to override `title` when the displayed title and SEO title should be different. | | `sidebar_label` | `string` | `title` | A custom label for the blog sidebar, replacing the default one (`title`). | | `date` | `string` | File name or file creation time | The blog post creation date. If not specified, this can be extracted from the file or folder name, e.g, `2021-04-15-blog-post.mdx`, `2021-04-15-blog-post/index.mdx`, `2021/04/15/blog-post.mdx`. Otherwise, it is the Markdown file creation time. | | `tags` | `Tag[]` | `undefined` | A list of strings or objects of two string fields `label` and `permalink` to tag to your post. Strings can be a reference to keys of a [tags file](#tags-file) (usually `tags.yml`) | diff --git a/website/versioned_docs/version-3.7.0/api/plugins/plugin-content-docs.mdx b/website/versioned_docs/version-3.7.0/api/plugins/plugin-content-docs.mdx index b14df36827..fa9ddbf53e 100644 --- a/website/versioned_docs/version-3.7.0/api/plugins/plugin-content-docs.mdx +++ b/website/versioned_docs/version-3.7.0/api/plugins/plugin-content-docs.mdx @@ -278,7 +278,6 @@ Accepted fields: | --- | --- | --- | --- | | `id` | `string` | file path (including folders, without the extension) | A unique document ID. | | `title` | `string` | Markdown title or `id` | The text title of your document. Used for the page metadata and as a fallback value in multiple places (sidebar, next/previous buttons...). Automatically added at the top of your doc if it does not contain any Markdown title. | -| `title_meta` | `string` | `frontMatter.title` | The SEO metadata title of your document used in `<head>` for `<title>` and `og:title`. Permits to override `frontMatter.title` when the displayed title and SEO title should be different. | | `pagination_label` | `string` | `sidebar_label` or `title` | The text used in the document next/previous buttons for this document. | | `sidebar_label` | `string` | `title` | The text shown in the document sidebar for this document. | | `sidebar_position` | `number` | Default ordering | Controls the position of a doc inside the generated sidebar slice when using `autogenerated` sidebar items. See also [Autogenerated sidebar metadata](/docs/sidebar/autogenerated#autogenerated-sidebar-metadata). |