Redocly / Redocly/redoc

Sections with parenthesis in headings rendered twice

Open
#2,669 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Bug
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the bug
When you have some parenthesis in the heading of a description of a tag the whole section gets rendered twice with different font sizes.

Expected behavior
The section should only be rendered once with a consistent font size like the other sections.

Minimal reproducible OpenAPI snippet(if possible)

openapi: 3.1.0

info:
  title: OpenAPI Minimal Example

tags:
  - name: Correct Rendering
    description: |
      # This H1 gets rendered correctly
      Some text.
  - name: Incorrect Rendering
    description: |
      # This H1 gets rendered incorrectly (parentheses cause it to be rendered twice with different font sizes)
      Some other text.

Screenshots
Image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the minimal OpenAPI YAML snippet in the issue and compare rendering of the two tag descriptions, especially the heading containing parentheses. Trace the tag-description rendering entry point and identify why the parenthesized heading appears twice. Done means each section renders once with a consistent font size, matching the heading without parentheses.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.