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

Eliminate requirement to add blank line to get markdown formatting #2959

Open
wants to merge 4 commits into
base: next
Choose a base branch
from

Conversation

hughess
Copy link
Member

@hughess hughess commented Dec 31, 2024

Description

Currently, when using components or each/if blocks, a blank line is required to get markdown formatting.

This PR removes the need for a blank line by injecting it for you behind the scenes.

This PR needs solid testing before merging

Example

<Alert>
This is a **default** alert
</Alert>

Before

CleanShot 2024-12-31 at 15 45 40@2x

After

CleanShot 2024-12-31 at 15 50 22@2x

Testing Needed

  • Are all edge cases covered? Currently covers:
    • HTML tags excluded
    • Components inside strings excluded
    • Components inside code blocks
  • Does this affect page load significantly?
  • Each and if block testing
  • Nested components and each/if blocks testing
  • Ideally we should have a workaround to give people if there are edge cases we miss and it breaks the content on the page

Checklist

  • For UI or styling changes, I have added a screenshot or gif showing before & after
  • I have added a changeset

@archiewood
Copy link
Member

archiewood commented Jan 2, 2025

Related:

  • Lists

#479

@hughess
Copy link
Member Author

hughess commented Jan 2, 2025

now includes a fix for lists

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.

2 participants