rushstack icon indicating copy to clipboard operation
rushstack copied to clipboard

[api-documenter] How to configure the generated Markdown (md) file name?

Open niming175 opened this issue 7 months ago • 0 comments
trafficstars

Summary

生成的markdown 文件是以package.json 中的name字段为前缀,如

// package.json
{
  "name": "test-api",
  "version": "1.0.0",
   ...
}

那我生成的md文件怎是 test-api.xxxx.md。 请问,我要如何去掉这个前缀?


The generated Markdown files are prefixed with the name field in the package.json file. For example:

// package.json
{
  "name": "test-api",
  "version": "1.0.0",
  ...
}

In this case, the generated Markdown files will be named like test-api.xxxx.md. May I ask how I can remove this prefix?

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

niming175 avatar Apr 10 '25 12:04 niming175