Skip to content

Redocly: Add support for content on redocly pages #329

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

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

Conversation

nginx-jack
Copy link
Collaborator

I know. I can't help myself. More redocly changes.

This removes the concept of a redocly "layout" in hugo, and instead, uses it as a standard shortcode.
The main benefit of this is that you can have other content on a page besides redocly.

For now, you still need the frontmatter

tags:
  - api
doctypes:
  - reference

This stops the redocly js files loading on every page. We should investigate a way to have hugo check a page for redocly usage, and pull the script in automatically.

Screenshot 2025-07-25 at 13 29 33

@nginx-jack nginx-jack requested a review from a team as a code owner July 25, 2025 12:32
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-hugo-theme/329/

@lamATnginx
Copy link
Collaborator

Do we want tiny redocly width?

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.

3 participants