Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[api-documenter] How can I remove the escape character \ before the symbol _? #5192

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

Open
niming175 opened this issue Apr 10, 2025 · 0 comments

Comments

@niming175
Copy link

niming175 commented Apr 10, 2025

Summary

在生成的markdown 文档中,带有_的符号,都会加上\,如标题文本# THIS_IS_TEST_TITLE 生成md文件后是:

# THIS\_IS\_TEST\_TITLE

要如何去掉这个额外的符号?
我是用docusaurus(版本: 3.7.0)来部署我的文档,_不需要\_转译。而自动生成的侧边栏,会原样显示\_符号。


In the generated Markdown document, any symbol with an _ will have a \ added in front of it. For example, if the title text is # THIS_IS_TEST_TITLE, after generating the MD file, it will be:

# THIS\_IS\_TEST\_TITLE

How can I remove this extra symbol?
I am using docusaurus (version: 3.7.0) to deploy my documentation. The _ does not need to be escaped with _. However, in the automatically generated sidebar, the _ symbol will be displayed as it is.

Repro steps

Expected result:

Actual result:

Details

Standard questions

Please answer these questions to help us investigate your issue more quickly:

Question Answer
@microsoft/api-documenter version? 7.26.3
Operating system? Linux
Documentation target? Markdown
Would you consider contributing a PR? NO
TypeScript compiler version? 5.7.2
Node.js version (node -v)? 20.14.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Needs triage
Development

No branches or pull requests

1 participant