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.

Sign up for GitHub

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

Jump to bottom

README: fix MarkDown render mistakes #77

Closed
wants to merge 1 commit into from
Closed

README: fix MarkDown render mistakes #77

wants to merge 1 commit into from

Conversation

GerHobbelt
Copy link

README: fix MarkDown render mistakes in MSVC IDE (& possibly elsewhere): C++17 was rendered as strike-through instead of literal C++17.

@GerHobbelt
fix MarkDown render mistakes in MSVC IDE (& possibly elsewhere): `C++…
f03ee43 
…17` was rendered as strike-through instead of literal `C++17`.

# Conflicts:
#	README.md
@bshoshany
Copy link
Owner

bshoshany commented Aug 23, 2022 •
edited

Thanks for this pull request. I can confirm that this line is indeed rendered wrong on VS 2022 when using the Markdown Editor v2 extension (the most popular Markdown preview extension for VS). Apparently this extension interprets ++ as "inserted text", due to using markdig, which includes some non-standard Markdown extensions. I will incorporate your suggestion into the next release (v3.4.0) to ensure that this line renders correctly on VS. Thanks again!

@bshoshany bshoshany closed this Aug 23, 2022
@bshoshany
Copy link
Owner

PS: This VS extension also renders C++ incorrectly on other lines, so I'll have to fix those too...

@GerHobbelt
Copy link
Author

Fun. Hadn't observed those in MSVC2019. May be my eyes; I blame it on software releases. 😉

👍

@bshoshany
Copy link
Owner

See for example the sentences "the package only utilizes the C++17 standard library" and "As this library requires C++17 features". The solution seems to be replacing every occurrence of C++17 with C\+\+17 which unfortunately makes the text less readable when you're just reading the source code instead of the preview. But since this is how the preview is displayed in the most popular VS Markdown extension, I guess there's no choice but to change it.

@bshoshany
Copy link
Owner

Update: this is now implemented in v3.4.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@GerHobbelt @bshoshany