Skip to content

[api-documenter] Add a setting to remove the "do not edit" comment from the generated markdown #5176

Open
@niming175

Description

@niming175

Summary

在生产的md文档中,在每个文件的顶部都会有这么一句:

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

这个在使用docusaurus部署我的文档会有影响。
所以,我想去掉这个注释,我该如何做?

In the generated Markdown (.md) documents, there is a line at the top of each file:

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

This causes issues when deploying my documentation using Docusaurus.
So, I want to remove this comment. How can I do that?

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementThe issue is asking for a new feature or design change

    Type

    No type

    Projects

    Status

    Needs triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions