Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

consistently "truncate" blogs and resolve Docusaurus warnings #254

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

cburroughs
Copy link
Contributor

Since the update to 3.5, Docusaurus has spit out this new WARNING

[WARNING] Docusaurus found blog posts without truncation markers:
- "blog/2024-07-01-building-linux-on-osx-silicon/index.mdx"
- "blog/2024-06-13-announcing-klaviyo-sponsorship/index.mdx"
- "blog/2024-04-27-simple-versioning-with-git-tags/index.mdx"

We recommend using truncation markers (`<!-- truncate -->` or `{/* truncate */}`) in blog posts to create shorter previews on blog paginated lists.
Tip: turn this security off with the `onUntruncatedBlogPosts: 'ignore'` blog plugin option.

To resolve this I've:

  • Added truncate to those blog posts that were missing it
  • Moved the truncate for 2024 blog posts to always capture at least a little text (and not just the splash image).

Since the update to 3.5, Docusaurus has spit out this new WARNING

```
[WARNING] Docusaurus found blog posts without truncation markers:
- "blog/2024-07-01-building-linux-on-osx-silicon/index.mdx"
- "blog/2024-06-13-announcing-klaviyo-sponsorship/index.mdx"
- "blog/2024-04-27-simple-versioning-with-git-tags/index.mdx"

We recommend using truncation markers (`<!-- truncate -->` or `{/* truncate */}`) in blog posts to create shorter previews on blog paginated lists.
Tip: turn this security off with the `onUntruncatedBlogPosts: 'ignore'` blog plugin option.
```

To resolve this I've:
 * Added `truncate` to those blog posts that were missing it
 * Moved the `truncate` for 2024 blog posts to always capture at least
 a little text (and not just the splash image).
@cburroughs cburroughs requested review from benjyw and huonw August 23, 2024 18:47
@cburroughs cburroughs self-assigned this Aug 23, 2024
Copy link
Contributor

@huonw huonw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for this

@cburroughs cburroughs merged commit 542bd02 into main Aug 26, 2024
1 check passed
@cburroughs cburroughs deleted the csb/blog-truncate branch August 26, 2024 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants