rushstack
rushstack copied to clipboard
[api-documenter] New api-documenter.json for customizing/eliminating generated strings
β¦ious output notices, as well as disabling the "breadcrumb" generation
Summary
This is currently a DRAFT pull request. I'm proposing some new api-documenter.json settings to address two feature requests:
-
Remove the navigation "breadcrumb" links from the generated .md files: https://github.com/microsoft/rushstack/issues/5177
-
Remove the
Do not edit this filenotice from the generated .md files: https://github.com/microsoft/rushstack/issues/5176
I went a step further and designed an option for configuring the text of various notices. To eliminate a notice entirely, you would set its text to be an empty string ("").
Details
There is currently some confusion where api-documenter markdown does not read api-documenter.json, whereas api-documenter generate does use this config file. We had some plans to clarify that, but I've forgotten the details. Need to investigate before proceeding.