-
Notifications
You must be signed in to change notification settings - Fork 59.8k
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
The Markdown formatting is not ignored in the issue title using the escape character. Example: \test\
.
#24940
Comments
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. |
Thanks for the issue @5AbhishekSaxena, I'll get this triaged for 👀 |
No problem @steveward, happy to contribute 😁. |
Thanks for opening this issue! You or anyone else is welcome to note this exception in the docs. |
I was thinking instead of adding this exception in the docs, the issue should be fixed in the code itself where the backticks are processed which formats the title of the issue/pull but acknowledge the escaping character, and skip the formatting. |
@5AbhishekSaxena - Here in this repo, we work on the documentation site and articles. For now, the best fix is to update the docs to the behavior. The best place to leave feedback for the change in behavior you are suggesting would likely be with the |
I have raised a PR which adds a note informing the user about the issue. I have also started a discussion on the community page which can be found here: https://github.com/orgs/community/discussions/54689. |
Code of Conduct
What article on docs.github.com is affected?
File: https://github.com/github/docs/blob/main/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md#ignoring-markdown-formatting
Page: https://github.com/github/docs/blob/main/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md#ignoring-markdown-formatting
The above-mentioned section talks about how one can tell Github to ignore the Markdown by using
\
but using this character. This works everywhere but not in the title of the issue and I am assuming in the title of the PRs.An example of the issue is in the title of this issue itself.
What changes are you suggesting?
The Github should acknowledge the escape character (
\
) as it does at the other places and allow the users to ignore the Markdown formatting in the title of the issues.Additional information
No response
The text was updated successfully, but these errors were encountered: