openapi-starter icon indicating copy to clipboard operation
openapi-starter copied to clipboard

<PullRight> tag not working

Open timothymcmackin opened this issue 2 years ago • 2 comments

I'm trying to use the <PullRight> tag to move code into the right-hand column as described here: https://redocly.com/docs/api-reference-docs/guides/embedded-markdown/#pull-right

I created a repo from this starter and added this section to info-description.md:

# Pullright test

Hello!

<PullRight>
This should be in the right pane.
</PullRight>

Here is some more text.

When I view this in the browser, the text is still in the center pane: image

Here's my minimal reproduction: https://github.com/timothymcmackin/redocly-api-ref-pullright

Is there something else I have to set up to use the PullRight tag?

timothymcmackin avatar Apr 22 '22 11:04 timothymcmackin

If you're not using a license key with OpenAPI CLI, the documentation preview you're getting in the browser is generated by Redoc. I think the problem might be that the <PullRight> tag is not supported by Redoc. It only works in the premium Reference product.

  • You would first have to register for a free Redocly account - https://app.redocly.com/signup
  • Then, create an API key - https://redocly.com/docs/settings/personal-api-keys/
  • Then you can use the key with the OpenAPI login and preview-docs commands to test the PullRight tag:
    • https://redocly.com/docs/cli/commands/login/
    • https://redocly.com/docs/cli/commands/preview-docs/

If it still doesn't work even when you use the license key, let us know - it could be that something else is causing the problem.

ivana-isadora avatar Apr 22 '22 11:04 ivana-isadora

I am also having the same issue, but within the developer portal. The content I put inside PullRight tag is still displayed in the main panel not right panel. How can I use PullRight within developer portal inside the API reference?

sahingoko avatar Aug 25 '23 15:08 sahingoko