knuckleswtf / scribe

Generate API documentation for humans from your Laravel codebase.✍
https://scribe.knuckles.wtf/laravel/
MIT License
1.58k stars 280 forks source link

Example Request buggy in Elements Theme #810

Closed LaurinStapf closed 4 months ago

LaurinStapf commented 4 months ago

Scribe version

4.30.1

PHP version

8.2

Framework

Laravel

Framework version

latest

Scribe config

I don't think we need it, but please let us know if we do

What happened?

The example request in the elements theme is truncated if the body is too long and only partially appears after the example response. An example can be seen in the image

image

A fix would be very helpful in that regard, I think it's just a style problem here.

Sometimes the two texts also collide with each other

Docs

shalvah commented 4 months ago

Sorry about that! Unfortunately, I can't promise any timeline for when this will be fixed, as I'm quite busy. However, if you'd like to use the elements theme, you can try switching type to external_laravel. This uses the CSS + JavaScript directly from the Elements website, so there shouldn't be any rendering issues from our side. The only difference is that the doc is fetched and rendered client-side based on your OpenAPI spec.

LaurinStapf commented 4 months ago

Alright, thanks for the fast reply, I will try this. 👌🏼