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

Supporting single tilde ~ as a strikethrough text #36995

Closed
1 task done
amitse opened this issue Mar 20, 2025 · 2 comments · Fixed by #37055
Closed
1 task done

Supporting single tilde ~ as a strikethrough text #36995

amitse opened this issue Mar 20, 2025 · 2 comments · Fixed by #37055
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@amitse
Copy link
Contributor

amitse commented Mar 20, 2025

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#styling-text
strikethrough

What part(s) of the article would you like to see updated?

Strikethrough | ~~ ~~ | None | ~~This was mistaken text~~ | This was mistaken text -- | -- | -- | -- | --

Additional information

Accoding to GFM both single tilde ~ and double tilde ~~ are valid strikethrough markers,

Why don't we mention abnout single tilde ~ in the github docs?

~Sample single tilde~
~~sample double tilde~~

Output
Sample single tilde
sample double tilde

@amitse amitse added the content This issue or pull request belongs to the Docs Content team label Mar 20, 2025
Copy link

welcome bot commented Mar 20, 2025

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 20, 2025
@Sharra-writes Sharra-writes added help wanted Anyone is welcome to open a pull request to fix this issue and removed triage Do not begin working on this issue until triaged by the team labels Mar 20, 2025
@Sharra-writes
Copy link
Contributor

Thanks so much for opening this issue! You, or anyone else, are welcome to submit a PR with this fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants