Skip to content
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

[api-documenter] New api-documenter.json for customizing/eliminating generated strings #5178

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

octogonz
Copy link
Collaborator

@octogonz octogonz commented Apr 2, 2025

…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:

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.

How it was tested

Impacted documentation

…ious output notices, as well as disabling the "breadcrumb" generation
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

Successfully merging this pull request may close these issues.

1 participant