Skip to content

Enhance layout handling for OpenAPI and full-width modes#3957

Draft
Marcoscisneros wants to merge 3 commits intomainfrom
marcos/new-layout-prototype
Draft

Enhance layout handling for OpenAPI and full-width modes#3957
Marcoscisneros wants to merge 3 commits intomainfrom
marcos/new-layout-prototype

Conversation

@Marcoscisneros
Copy link

@Marcoscisneros Marcoscisneros commented Jan 28, 2026 •
edited
Loading

Summary

This PR introduces a new layout mode system for GitBook pages and fixes overflow issues with blocks in wide/OpenAPI layouts.

Key Changes:

  • New layout mode variants: Added layout-default, layout-openapi, and layout-full-width Tailwind variants to control page structure based on content type
  • Fixed block overflow in OpenAPI mode: Moved left padding from individual blocks to container level, preventing double-padding on nested blocks (tabs, hints, expandables, steppers)
  • Page cover styling fixes: Removed negative margins and added proper width handling for full-width page covers
  • TableOfContents: Now properly hidden in full-width mode
  • Footer grid simplification: Replaced complex selector combinations with cleaner layout mode variants
  • PreservePageLayout: Updated to preserve layout mode classes during page transitions

Layout Modes:

Mode Structure Use Case
layout-default TOC + Content + Outline Standard pages with table of contents
layout-openapi TOC + Content (no Outline) Pages with OpenAPI blocks
layout-full-width Content only Pages without TOC enabled

Test plan

  • Verify pages with OpenAPI blocks render correctly without left overflow on hints, tabs, expandables, and steppers
  • Verify full-width pages (no TOC) display content centered with proper max-width
  • Verify page cover images display at full width without negative margin overflow
  • Verify navigation between pages with different layout modes preserves styling during transitions
  • Verify footer grid responds correctly to different layout modes
  • Verify table of contents is hidden on full-width pages

@changeset-bot
Copy link

changeset-bot bot commented Jan 28, 2026 •
edited
Loading

⚠️ No Changeset found

Latest commit: ddcb22e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@github-actions
Copy link
Contributor

github-actions bot commented Jan 28, 2026 •
edited
Loading

Summary of the deployments:

Version URL Status
Vercel ❌
Cloudflare ❌

Test content

Site 2v 2c
GitBook /url/gitbook.com/docs /url/gitbook.com/docs
E2E /url/gitbook.gitbook.io/test-gitbook-open /url/gitbook.gitbook.io/test-gitbook-open

@Marcoscisneros
Enhance layout handling for OpenAPI and full-width modes
2d7954f 
- Removed deprecated configuration from bun.lock.
- Added new layout variants in tailwind.config.ts for better control over page structure.
- Updated DocumentView and related components to support full-width and OpenAPI layouts, ensuring proper styling and responsiveness.
- Introduced utility functions to check for OpenAPI blocks in documents.
- Adjusted various components to conditionally apply styles based on the layout mode, improving overall layout consistency.
@Marcoscisneros Marcoscisneros force-pushed the marcos/new-layout-prototype branch from a19b63b to 2d7954f Compare January 28, 2026 12:55
@argos-ci
Copy link

argos-ci bot commented Jan 28, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
customers-v2 (Inspect) ⚠️ Changes detected (Review) 39 changed, 4 removed, 1 failure Jan 28, 2026, 1:08 PM
v2-cloudflare (Inspect) ⚠️ Changes detected (Review) 51 changed Jan 28, 2026, 1:13 PM
v2-vercel (Inspect) ⚠️ Changes detected (Review) 60 changed Jan 28, 2026, 1:12 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Marcoscisneros @zenoachtig