swagger-api / swagger-api/swagger-ui
Inline MarkDown code blocks are overlapping due to high vertical padding
Open
Nobody has claimed this yet.
cat: style & presentation
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Q&A
- OS: Windows
- Browser: Firefox
- Version: 93
- Method of installation: webjar
- Swagger-UI version: latest master branch
- Swagger/OpenAPI version: Swagger 2.0, OpenAPI 3.0
Content & configuration
Example Swagger/OpenAPI definition:
"/api/v1/some_endpoint": {
"post": {
"description": "**Logical operators** (lowercase and case-sensitive):\n\n* AND operator: `;` or `and`\n* OR operator: `,` or `or`\n\n"
}
}
Describe the bug you're encountering
The inline code blocks are overlapping due to the high vertical padding set in _markdown.scss#L18
Expected behavior
No overlapping between code blocks should occur.
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 at src/style/_markdown.scss#L18, which the issue identifies as the source of the excessive vertical padding. Reproduce the example in Firefox and adjust the styling so inline Markdown code blocks no longer overlap, then verify the expected rendering against the supplied screenshot and description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scss
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100