swagger-api / swagger-api/swagger.io-docs

Is there a way i can change the documentation style ? I even can not see the yaml text,expect I scroll the text with my mouse.

Open
#243 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Astro
Stars
1.6k
Forks
407
Avg merge
2m
Merged PRs (30d)
2

Description

Content & configuration

As my description in title, when I see the documentation in your website.
I get the view:
image
I can not see the text in the yaml, It's a bad experience I think, can you change another style to make the yaml more  clear?
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 linked Swagger documentation page and inspect how the YAML example is displayed and styled. The issue is done when the YAML is clearly readable without requiring horizontal mouse scrolling, with the result checked against the reported screenshots.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.