Update basic-writing-and-formatting-syntax.md#37055
Update basic-writing-and-formatting-syntax.md#37055Sharra-writes merged 1 commit intogithub:mainfrom
Conversation
add single tilde `~` as valid strikethrough syntax
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the basic writing and formatting syntax documentation to note that both double tilde (~~ ~~) and single tilde (~ ~) can be used for strikethrough formatting according to the GFM specification.
- Updated the strikethrough row to include single tilde markup.
- Adjusted the table to reflect that both tilde formats are valid.
Comments suppressed due to low confidence (1)
content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md:39
- [nitpick] The updated table row mentions the single tilde (~ ~) as valid syntax, but the provided code example still only shows the double tilde usage. Consider adding an example using single tilde to illustrate the new functionality.
| Strikethrough | `~~ ~~` or `~ ~` | None | `~~This was mistaken text~~` | ~~This was mistaken text~~ |
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksThe table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
Thanks so much for opening a PR with this fix! I'll update the branch and get this merged once tests are passing 🍏 |
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
add single tilde
~as valid strikethrough syntaxWhy:
Closes: #36995
What's being changed (if available, include any code snippets, screenshots, or gifs):
Accoding to GFM both single tilde ~ and double tilde ~~ are valid strikethrough markers,
Check off the following: