Skip to content

Is is possible to customize admonition section for deprecated api? #1082

Open
@redjen8

Description

@redjen8

Is your feature request related to a problem?

I'm creating api doc pages for non native english speakers.
In the case of an api marked with deprecated, I have confirmed that the mdx file is created with the warning admonition automatically.
Can I request this by applying new custom markdownGenerators options?

Describe the solution you'd like

export function createDeprecationNotice({
  deprecated,
  description,
}: DeprecationNoticeProps) {
  return guard(deprecated, () =>
    createAdmonition({
      children:
        description && description.length > 0
          ? clean(description)
          : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
    })
  );
}

I wish there was a good way to customize the automatically generated deprecation message (Please check below example)

Image

Describe alternatives you've considered

Is there any way to customize createDeprecationNotice function by applying markdownGenerators option?

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions