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

feat: add redocBundleURL option #1835

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dmosberger
Copy link

What/Why/How?

It is helpful to be able render documentation with a non-standard redoc bundle, e.g., for testing. In theory, one could use a custom HTML template for this purpose but in practice that's not straight-forward because the template would have to be different depending on whether or not preview-docs or build-docs is run. The template would also have to include all the CSS code.

Testing

unit tests and e2e tests all passed.

@dmosberger dmosberger requested review from a team as code owners December 19, 2024 18:20
Copy link

changeset-bot bot commented Dec 19, 2024

🦋 Changeset detected

Latest commit: 7162e1b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@redocly/cli Minor
@redocly/openapi-core Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

It is helpful to be able render documentation with a non-standard
redoc bundle, e.g., for testing.  In theory, one could use a custom
HTML template for this purpose but in practice that's not
straight-forward because the template would have to be different
depending on whether or not `preview-docs` or `build-docs` is run.
The template would also have to include all the CSS code.
@dmosberger dmosberger force-pushed the add-option-redoc-bundle-url branch from 13b1c0b to 7162e1b Compare December 19, 2024 20:20
@tatomyr
Copy link
Contributor

tatomyr commented Dec 27, 2024

Thank you @dmosberger! We'll take a look at this soon.

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 this pull request may close these issues.

2 participants