gravitee-io / issues

Gravitee.io - API Platform - Issues
64 stars 26 forks source link

[APIM] Improve code block visibility on documentation pages in the developer portal #9210

Open sjanssens1977 opened 10 months ago

sjanssens1977 commented 10 months ago

Describe the bug

Code blocks are not displayed very clearly in the developer portal.

Notice the difference in rendering between the console markdown documentation WYSIWYG editor and the develop portal.

Using AsciiDoc type instead of Markdown makes no difference since code blocks in AsciiDoc type documentation pages are rendered in the same way as the markdown versions.

Is there a way to improve the rendering to make code blocks stand-out more (like the WYSIWYG render) in the developer portal?

To Reproduce

Create a Markdown type documentation page that contains a code block and publish is on the developer portal.

Expected behaviour

The code blocks in documentation pages should be rendered like the are presented in the WYSIWYG editor.

Current behaviour

Hardly any distinction between regular paragraph text and code blocks

Useful information

See above

Environment

What is the impacted version? Tested on both 3.20.16 and 4.0.4

bill-pond commented 8 months ago

This issue happens for inline code as well. In the Markdown editor you have a nice pink box around the inline code, but when rendered in developer portal, it becomes normal text (might be even worse as it is lightly bigger than normal).

sjanssens1977 commented 7 months ago

Keep-alive

pascal-schetelat commented 4 months ago

Same here. I must say the markdown rendering is not pleasing. Code block is hard to discern from text, the documentation look dated.

It pains me to show our doc like this : https://api-portail.bdnb.io/catalog/api/f4905edc-db58-3a3b-a8e5-c5dfc6692ee5/doc?page=39ca1b93-4d44-449a-8a1b-934d44e49af9#vous-cherchez-des-donn%C3%A9es-sur-des-b%C3%A2timents-dans-une-zone

Is there a way to add custom css ?

stale[bot] commented 1 month ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

JesterX666 commented 1 month ago

We still need this.