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

Update basic-writing-and-formatting-syntax.md #37055

Merged
merged 1 commit into from
Mar 24, 2025

Conversation

amitse
Copy link
Contributor

@amitse amitse commented Mar 23, 2025

add single tilde ~ as valid strikethrough syntax

Why:

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:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Sorry, something went wrong.

add single tilde `~` as valid strikethrough syntax
@Copilot Copilot bot review requested due to automatic review settings March 23, 2025 19:24
Copy link

welcome bot commented Mar 23, 2025

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.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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~~ |

Copy link
Contributor

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 links

⚠️ Warning: Our review server is experiencing latency issues.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on the review server. Changes to the data directory are not included in this table.

Source Review Production What Changed
get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md fpt
ghec
ghes@ 3.16 3.15 3.14 3.13 3.12
fpt
ghec
ghes@ 3.16 3.15 3.14 3.13 3.12

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 23, 2025
@Sharra-writes Sharra-writes added content This issue or pull request belongs to the Docs Content team and removed triage Do not begin working on this issue until triaged by the team labels Mar 24, 2025
@Sharra-writes Sharra-writes self-requested a review March 24, 2025 19:03
@Sharra-writes
Copy link
Contributor

Thanks so much for opening a PR with this fix! I'll update the branch and get this merged once tests are passing 🍏

@Sharra-writes Sharra-writes added this pull request to the merge queue Mar 24, 2025
Merged via the queue into github:main with commit d34acfc Mar 24, 2025
57 checks passed
Copy link
Contributor

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

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Supporting single tilde ~ as a strikethrough text
2 participants