Skip to content

Comments are not supported, but are part of the GFM spec #399

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

Open
3 tasks done
tsfischer opened this issue Mar 25, 2025 · 0 comments
Open
3 tasks done

Comments are not supported, but are part of the GFM spec #399

tsfischer opened this issue Mar 25, 2025 · 0 comments

Comments

@tsfischer
Copy link

tsfischer commented Mar 25, 2025

Describe the bug
Comments are part of the Github Flavored Markdown spec: Source

However comments are not removed by this library, and instead are rendered as if they were clear text.

Checklist

  • I can reproduce this issue with a vanilla SwiftUI project.
  • I can reproduce this issue using the main branch of this package.
  • This bug hasn't been addressed in an existing GitHub issue.

Steps to reproduce
In a view body, try the following:

NOTE: Don't put a space between the ! and the first hypen. I had to do this to make it show up here on the report

`Markdown("<! -- This is a comment --> But this is not")

Expected behavior
Should output the text:

"But this is not"

Actual behavior
Outputs the text:

"<! -- This is a comment --> But this is not" (without the space after the !)

Screenshots
If applicable, add screenshots to help explain your problem.

Version information

  • MarkdownUI: [2.4.1]
  • OS: [MacOS 15.3.2]
  • Xcode: [e.g. 16.0]
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

No branches or pull requests

1 participant