From 7e01f36f370e704f339211b17255e04dc10b7172 Mon Sep 17 00:00:00 2001 From: allyw2002 <72360926+allyw2002@users.noreply.github.com> Date: Wed, 3 May 2023 11:17:27 -0500 Subject: [PATCH] docs: mention blog truncating marker edge case (#8953) --- website/docs/blog.mdx | 2 +- website/versioned_docs/version-2.0.1/blog.mdx | 2 +- website/versioned_docs/version-2.1.0/blog.mdx | 2 +- website/versioned_docs/version-2.2.0/blog.mdx | 2 +- website/versioned_docs/version-2.3.1/blog.mdx | 2 +- website/versioned_docs/version-2.4.0/blog.mdx | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/website/docs/blog.mdx b/website/docs/blog.mdx index 2c1bb0179e..742692f555 100644 --- a/website/docs/blog.mdx +++ b/website/docs/blog.mdx @@ -76,7 +76,7 @@ The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front- The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed. -Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example: +Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown. For example: ```md title="website/blog/my-post.md" {7} --- diff --git a/website/versioned_docs/version-2.0.1/blog.mdx b/website/versioned_docs/version-2.0.1/blog.mdx index cc91a00324..66d728ddf9 100644 --- a/website/versioned_docs/version-2.0.1/blog.mdx +++ b/website/versioned_docs/version-2.0.1/blog.mdx @@ -76,7 +76,7 @@ The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front- The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed. -Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example: +Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown. For example: ```md --- diff --git a/website/versioned_docs/version-2.1.0/blog.mdx b/website/versioned_docs/version-2.1.0/blog.mdx index cc91a00324..66d728ddf9 100644 --- a/website/versioned_docs/version-2.1.0/blog.mdx +++ b/website/versioned_docs/version-2.1.0/blog.mdx @@ -76,7 +76,7 @@ The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front- The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed. -Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example: +Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown. For example: ```md --- diff --git a/website/versioned_docs/version-2.2.0/blog.mdx b/website/versioned_docs/version-2.2.0/blog.mdx index cc91a00324..66d728ddf9 100644 --- a/website/versioned_docs/version-2.2.0/blog.mdx +++ b/website/versioned_docs/version-2.2.0/blog.mdx @@ -76,7 +76,7 @@ The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front- The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed. -Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example: +Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown. For example: ```md --- diff --git a/website/versioned_docs/version-2.3.1/blog.mdx b/website/versioned_docs/version-2.3.1/blog.mdx index 02f870da6f..cb3110859a 100644 --- a/website/versioned_docs/version-2.3.1/blog.mdx +++ b/website/versioned_docs/version-2.3.1/blog.mdx @@ -76,7 +76,7 @@ The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front- The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed. -Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example: +Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown. For example: ```md --- diff --git a/website/versioned_docs/version-2.4.0/blog.mdx b/website/versioned_docs/version-2.4.0/blog.mdx index 02f870da6f..cb3110859a 100644 --- a/website/versioned_docs/version-2.4.0/blog.mdx +++ b/website/versioned_docs/version-2.4.0/blog.mdx @@ -76,7 +76,7 @@ The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front- The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed. -Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example: +Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown. For example: ```md ---