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

The Markdown formatting is not ignored in the issue title using the escape character. Example: \test\. #24940

Closed
1 task done
5AbhishekSaxena opened this issue Apr 8, 2023 · 7 comments · Fixed by #25434
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@5AbhishekSaxena
Copy link
Contributor

5AbhishekSaxena commented Apr 8, 2023

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

@5AbhishekSaxena 5AbhishekSaxena added the content This issue or pull request belongs to the Docs Content team label Apr 8, 2023
@welcome
Copy link

welcome bot commented Apr 8, 2023

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 Apr 8, 2023
@steveward steveward added get started Content related to "Getting Started" doc set waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Apr 14, 2023
@steveward
Copy link
Member

Thanks for the issue @5AbhishekSaxena, I'll get this triaged for 👀

@5AbhishekSaxena
Copy link
Contributor Author

No problem @steveward, happy to contribute 😁.

@skedwards88
Copy link
Contributor

Thanks for opening this issue! You or anyone else is welcome to note this exception in the docs.

@skedwards88 skedwards88 added help wanted Anyone is welcome to open a pull request to fix this issue and removed waiting for review Issue/PR is waiting for a writer's review labels Apr 20, 2023
@5AbhishekSaxena
Copy link
Contributor Author

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.

@cmwilson21
Copy link
Contributor

@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 Issues team here.

@5AbhishekSaxena
Copy link
Contributor Author

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.

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 get started Content related to "Getting Started" doc set 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.

4 participants