Skip to content

PR Summary: Consistent Layout and Tutorial Enhancements #1225

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 3 commits into
base: main
Choose a base branch
from

Conversation

AH-Avalanche
Copy link
Collaborator

@AH-Avalanche AH-Avalanche commented Apr 28, 2025

Overview

This PR implements a new grid-based layout system for documentation content that provides better control over content width and image placement. The system uses CSS Grid to create three distinct layout zones: content, breakout, and full-width.

Changes

  • Added a new grid layout system in src/css/custom.css that defines three layout zones:
    • Content zone (680px max-width)
    • Breakout zone (extends beyond content width)
    • Full-width zone (spans entire viewport)

Key Features

  1. Responsive Grid Structure

    • Content is centered with a max-width of 680px
    • Breakout areas extend up to 1200px
    • Full-width sections span the entire viewport
    • Maintains consistent padding on both sides
  2. Layout Zones

    • .theme-doc-markdown: Main container with grid definition
    • .breakout: For content that needs to extend beyond the main content width
    • .full-width: For elements that should span the entire viewport width
  3. Image Handling

    • Images within paragraphs automatically use the breakout zone
    • Full-width images can span the entire viewport with img.full-width class
    • Images maintain aspect ratio with object-fit: cover

Implementation Details

.theme-doc-markdown {
  --padding-inline: 1rem;
  --content-max-width: 680px;
  --breakout-max-width: 1200px;
  /* ... grid definition ... */
}

Testing

Please verify:

  1. Content is properly centered with max-width of 680px
  2. Images in paragraphs extend into the breakout zone
  3. Full-width elements span the entire viewport
  4. Layout remains responsive on different screen sizes

Screenshots

[Add screenshots showing the different layout zones in action]
Screenshot 2025-05-06 at 7 52 03 AM

This PR introduces consistent layout styling across documentation pages and enhances the tutorial presentation. The changes focus on improving content readability and visual consistency.
Copy link

netlify bot commented Apr 28, 2025

Deploy Preview for snowplow-docs ready!

Name Link
🔨 Latest commit ca37b42
🔍 Latest deploy log https://app.netlify.com/sites/snowplow-docs/deploys/6819fc1aa466b70008f9d528
😎 Deploy Preview https://deploy-preview-1225--snowplow-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@AH-Avalanche AH-Avalanche self-assigned this May 1, 2025
@AH-Avalanche AH-Avalanche marked this pull request as draft May 1, 2025 12:19
@AH-Avalanche AH-Avalanche marked this pull request as ready for review May 6, 2025 11:53
@mscwilson
Copy link
Collaborator

It's gone all thin!
Screenshot 2025-05-08 at 16 47 58

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants