Strange rendering of Markdown when headers has similar text
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the bug
For some reason when H2 header repeats with similar text, Redoc Standalone JS parses Markdown and adds content to next section.
Please note that if I change first header from Fiskaly ES to Fiskaler ES, than everything is working fine.
*Minimal reproducible OpenAPI snippet
This is the OpenAPI content (partial):
"info": {
"version": "local",
"title": "Our API Documentation",
"description": "\n# Integrations\n\n## Fiskaly ES \nSome Description \n## Fiskaly \nSome Description \n## Oracle Netsuite \nSome Description "
},
Screenshots
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the minimal OpenAPI snippet in the issue and reproduce it in Redoc Standalone JS, comparing the rendering of the similar H2 headings. Trace the Markdown heading parsing or section-rendering entry point responsible for the misplaced content. Done means headings such as “Fiskaly ES” and “Fiskaly” render separate sections with their own descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100