Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is there an option to remove excessive whitespace? #874

Closed
securisec opened this issue Mar 27, 2019 · 8 comments
Closed

Is there an option to remove excessive whitespace? #874

securisec opened this issue Mar 27, 2019 · 8 comments

Comments

@securisec
Copy link

I am writing some simple api documentation using openapi 3.0.0, but am running into an issue with excessive whitespaces in my headings and sections. See attached screenshot.

I am following the example for the docker engine api docs which does not seem to have any excess whitespace. Is there is a setting that can reduce such excessive whitespaces?

I am building a static file using redoc-cli bundle swagger.yaml --output ./static/docs.html --options.hideDownloadButton --options.noAutoAuth. My yaml is:

    description: |

    # Definations
    ## Entry
      some data
    ## Section
      other data
    ## Collection
      some collection

image

@RomanHotsiy
Copy link
Member

It has been fixed in 548fae3

Will be available in the upcoming release

@RomanHotsiy
Copy link
Member

Oh, actually I checked again and I can't reproduce the exact issue you have on the old version.

Could you attach the output of redoc-cli here?

For me it renders as bellow:

image

There is big pacing between sections but smaller between heading and text

@securisec
Copy link
Author

@RomanGotsiy my output is this:

./node_modules/redoc-cli/index.js bundle ./api/swagger/swagger.yaml --output ./static/docs.html --options.hideDownloadButton

Prerendering docs

🎉 bundled successfully in: ./static/docs.html (1060 KiB) [⏱ 0.381s]

I am trying to make it look like the docker docs which looks like this

image

@RomanHotsiy
Copy link
Member

No, I mean attach the resulting html so I can check

@securisec
Copy link
Author

Ah, I think i was being dumb. My browser was not in full screen, and the responsive design i think is squishing and increasing the padding. Making the browser full screen fixes the issue.

@RomanHotsiy
Copy link
Member

Ahh, I see now. I will try to make it consistent.

@hlascelles
Copy link

We're seeing this as well. Here is the whitespace around a header in our docs:

image

Fixing it involves changing the 40px 0px padding to 0px 0px:

    .dluJDj {
      padding: 0 0 !important;
    }

    .hiuczA {
      padding: 0 0 !important;
    }

Of course, those autogenerated class names change between versions, so it's a losing battle.

If you're already looking at fixing the above, that's great 👍

@hlascelles
Copy link

hlascelles commented Nov 18, 2019

This has not fixed my issue. Specifically, this is nothing to do with small screens. Perhaps it is a different section. I open a new issue.

jmendiara added a commit to jmendiara/ReDoc that referenced this issue Feb 28, 2020
* feat(cli): added support for JSON string value for --options CLI argument (Redocly#1047)

closes Redocly#797

* docs: expandDefaultServerVariables

* fix: do not crash on empty scopes

fixes Redocly#1044

* fix: auth section appears twice

fixes Redocly#818

* fix: left menu item before group is not highligted

fixes Redocly#1033

* fix: clicking on group title breaks first tag

fixes Redocly#1034

* fix: false-positive recursive detection with allOf at the same level

* fix: remove excessive whitespace between md sections on small screens

fixes Redocly#874

* chore: Release 2.0.0-rc.15 🔖

* chore(cli): redoc-cli v0.9.0

* chore(cli): update yarn.lock

* chore(cli): [email protected]

* fix: fix scrollYOffset when SSR

* chore: Release 2.0.0-rc.16 🔖

* chore(cli): [email protected]

* docs: fix typo (Redocly#1062)

* feat: added support for file paths as --options cli argument (Redocly#1049)

* fix: types over-pluralization (Redocly#1057)

fixes Redocly#1053

* docs: improve options documentation (Redocly#1071)

* Sort by name
* Document `hideSingleRequestSampleTab`
* End option description with `.`

* fix: no quotes for default values in header fields. (Redocly#1059)

* fix: changed several components style font-family to monospace (Redocly#1063)

fixes Redocly#909

* fix: active menu item scroll into view

* chore: Release 2.0.0-rc.17 🔖

* fix: improve mime-type dropdown font

* fix: add oneOf buttons vertical space when wrapped to new line

* hore: Release 2.0.0-rc.18 🔖

* fix: wrap json examples in code tag (Redocly#1064)

* feat: display `multipleOf` constrains (Redocly#1065)

* docs: fix link to x-nullable docs from README (Redocly#1135)

* fix: change the title of "Security Scheme Type" to match "HTTP Authorization Scheme" (Redocly#1126)

* docs: fixed example slack api url (Redocly#1077)

* doc: fix some typos (Redocly#1117)

* feat(cli): Fallback on the spec's title before falling back on… (Redocly#1073)

* fix: do not URI-encode parameter values for better readability

fixes Redocly#1138

* chore: upgrade deps

* feat: enable menuToggle by default

* chore: remove react-hot-loader from deps

fixes Redocly#1133

* fix: support discriminator mapping 1-n

fixes Redocly#1111

* fix: remove hardcoded fontFamily for oneOf labels

fixes Redocly#1120

* fix: h2 padding on mobile

fixes Redocly#1118

* fix: python comment stripped in headings

fixes Redocly#1116

* feat: new option hideSchemaTitles

* fix: remove implicit discriminator mapping when explicit is present

* chore: refactor request samples

* feat: new option payloadSampleIdx

* fix: search-box use theme

* fix: fix sortByRequired (stabilise sort) (Redocly#1136)

fixes Redocly#1104
fixes Redocly#1121
fixes Redocly#1061

* chore: Release 2.0.0-rc.19 🔖

* chore: update npm token for travis deploy

* chore(cli): [email protected]

* fix: fix missing parameters

fixes Redocly#1142

* chore: Release 2.0.0-rc.20 🔖

* chore(cli): [email protected]

* fix: use mobile menu background color value from theme (Redocly#1144)

* chore(cli): Lint and prettify cli/index.ts (Redocly#1074)

* fix: fix duplicated content in tags when using md headings

fixes Redocly#1150, fixes Redocly#1152

* fix: empty servers behaviour per OAS spec

fixes Redocly#1151

* chore: fix travis export vars

* tests: fix tests for empty servers

* chore: Release 2.0.0-rc.21 🔖

* chore(cli): upgrade handlebars in yarn.lock

* chore(cli): update redoc

* chore(cli): [email protected]

* feat: add HTTP syntax highlighting (Redocly#1157)

* fix: do not process oneOf if inherited from parent with discriminator

* chore: minor perf optimizations

* chore: Release 2.0.0-rc.22 🔖

* fix: fix broken sticky sidebar in Chrome 80

fixes Redocly#1167

* chore: Release 2.0.0-rc.23 🔖

* chore(cli): [email protected]

Co-authored-by: Sergey Dubovyk <[email protected]>
Co-authored-by: Roman Hotsiy <[email protected]>
Co-authored-by: Anastasiya Mashoshyna <[email protected]>
Co-authored-by: Michael Huynh <[email protected]>
Co-authored-by: Alex <[email protected]>
Co-authored-by: russellrobinson <[email protected]>
Co-authored-by: Andrew Zhukevych <[email protected]>
Co-authored-by: Andrii Tykhan <[email protected]>
Co-authored-by: Dimitar Nanov <[email protected]>
Co-authored-by: bwjohnson-ss <[email protected]>
Co-authored-by: torbenw <[email protected]>
Co-authored-by: Chris Faulkner <[email protected]>
Co-authored-by: Zakary Kamal Ismail <[email protected]>
Co-authored-by: Nan Yan <[email protected]>
Co-authored-by: Anna Stasiuk <[email protected]>
Co-authored-by: Kryštof Korb <[email protected]>
jmendiara added a commit to jmendiara/ReDoc that referenced this issue Feb 28, 2020
* feat(cli): added support for JSON string value for --options CLI argument (Redocly#1047)

closes Redocly#797

* docs: expandDefaultServerVariables

* fix: do not crash on empty scopes

fixes Redocly#1044

* fix: auth section appears twice

fixes Redocly#818

* fix: left menu item before group is not highligted

fixes Redocly#1033

* fix: clicking on group title breaks first tag

fixes Redocly#1034

* fix: false-positive recursive detection with allOf at the same level

* fix: remove excessive whitespace between md sections on small screens

fixes Redocly#874

* chore: Release 2.0.0-rc.15 🔖

* chore(cli): redoc-cli v0.9.0

* chore(cli): update yarn.lock

* chore(cli): [email protected]

* fix: fix scrollYOffset when SSR

* chore: Release 2.0.0-rc.16 🔖

* chore(cli): [email protected]

* docs: fix typo (Redocly#1062)

* feat: added support for file paths as --options cli argument (Redocly#1049)

* fix: types over-pluralization (Redocly#1057)

fixes Redocly#1053

* docs: improve options documentation (Redocly#1071)

* Sort by name
* Document `hideSingleRequestSampleTab`
* End option description with `.`

* fix: no quotes for default values in header fields. (Redocly#1059)

* fix: changed several components style font-family to monospace (Redocly#1063)

fixes Redocly#909

* fix: active menu item scroll into view

* chore: Release 2.0.0-rc.17 🔖

* fix: improve mime-type dropdown font

* fix: add oneOf buttons vertical space when wrapped to new line

* hore: Release 2.0.0-rc.18 🔖

* fix: wrap json examples in code tag (Redocly#1064)

* feat: display `multipleOf` constrains (Redocly#1065)

* docs: fix link to x-nullable docs from README (Redocly#1135)

* fix: change the title of "Security Scheme Type" to match "HTTP Authorization Scheme" (Redocly#1126)

* docs: fixed example slack api url (Redocly#1077)

* doc: fix some typos (Redocly#1117)

* feat(cli): Fallback on the spec's title before falling back on… (Redocly#1073)

* fix: do not URI-encode parameter values for better readability

fixes Redocly#1138

* chore: upgrade deps

* feat: enable menuToggle by default

* chore: remove react-hot-loader from deps

fixes Redocly#1133

* fix: support discriminator mapping 1-n

fixes Redocly#1111

* fix: remove hardcoded fontFamily for oneOf labels

fixes Redocly#1120

* fix: h2 padding on mobile

fixes Redocly#1118

* fix: python comment stripped in headings

fixes Redocly#1116

* feat: new option hideSchemaTitles

* fix: remove implicit discriminator mapping when explicit is present

* chore: refactor request samples

* feat: new option payloadSampleIdx

* fix: search-box use theme

* fix: fix sortByRequired (stabilise sort) (Redocly#1136)

fixes Redocly#1104
fixes Redocly#1121
fixes Redocly#1061

* chore: Release 2.0.0-rc.19 🔖

* chore: update npm token for travis deploy

* chore(cli): [email protected]

* fix: fix missing parameters

fixes Redocly#1142

* chore: Release 2.0.0-rc.20 🔖

* chore(cli): [email protected]

* fix: use mobile menu background color value from theme (Redocly#1144)

* chore(cli): Lint and prettify cli/index.ts (Redocly#1074)

* fix: fix duplicated content in tags when using md headings

fixes Redocly#1150, fixes Redocly#1152

* fix: empty servers behaviour per OAS spec

fixes Redocly#1151

* chore: fix travis export vars

* tests: fix tests for empty servers

* chore: Release 2.0.0-rc.21 🔖

* chore(cli): upgrade handlebars in yarn.lock

* chore(cli): update redoc

* chore(cli): [email protected]

* feat: add HTTP syntax highlighting (Redocly#1157)

* fix: do not process oneOf if inherited from parent with discriminator

* chore: minor perf optimizations

* chore: Release 2.0.0-rc.22 🔖

* fix: fix broken sticky sidebar in Chrome 80

fixes Redocly#1167

* chore: Release 2.0.0-rc.23 🔖

* chore(cli): [email protected]

Co-authored-by: Sergey Dubovyk <[email protected]>
Co-authored-by: Roman Hotsiy <[email protected]>
Co-authored-by: Anastasiya Mashoshyna <[email protected]>
Co-authored-by: Michael Huynh <[email protected]>
Co-authored-by: Alex <[email protected]>
Co-authored-by: russellrobinson <[email protected]>
Co-authored-by: Andrew Zhukevych <[email protected]>
Co-authored-by: Andrii Tykhan <[email protected]>
Co-authored-by: Dimitar Nanov <[email protected]>
Co-authored-by: bwjohnson-ss <[email protected]>
Co-authored-by: torbenw <[email protected]>
Co-authored-by: Chris Faulkner <[email protected]>
Co-authored-by: Zakary Kamal Ismail <[email protected]>
Co-authored-by: Nan Yan <[email protected]>
Co-authored-by: Anna Stasiuk <[email protected]>
Co-authored-by: Kryštof Korb <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants