Skip to content

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

Open
@niming175

Description

@niming175

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?
Operating system?
Documentation target?
Would you consider contributing a PR?
TypeScript compiler version?
Node.js version (node -v)?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Needs triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions