Skip to content

Tutorial layout enhacements #1306

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.

Sign up for GitHub

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

Tutorial layout enhacements #1306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d283e64
Tutorial Spacing and padding Enhancements
AH-Avalanche Jun 30, 2025
78ad663
Tutorial Spacing and layout enhancements
AH-Avalanche Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/theme/DocItem/Layout/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ export default function DocItemLayout({ children }: Props): JSX.Element {
<div className={clsx('col', !docTOC.hidden && styles.docItemCol)}>
<DocVersionBanner />
<div className={styles.docItemContainer}>
<article className="overflow-x-auto max-w-none leading-relaxed prose prose-p:mt-0 prose-table:rounded-lg prose-td:ps-3 prose-td:pe-3 prose-th:ps-3 prose-th:pe-3 prose-ul:mt-0 prose-ol:mt-0 prose-code:before:content-none prose-code:after:content-none prose-code:font-normal prose-code:text-base prose-img:mx-auto prose-img:block">
<article className="overflow-x-auto max-w-fit leading-relaxed prose prose-p:mt-0 prose-table:rounded-lg prose-td:ps-3 prose-td:pe-3 prose-th:ps-3 prose-th:pe-3 prose-ul:mt-0 prose-ol:mt-0 prose-code:before:content-none prose-code:after:content-none prose-code:font-normal prose-code:text-base prose-img:mx-auto prose-img:block ">
<DocBreadcrumbs />
<DocVersionBadge />
{docTOC.mobile}
{tutorial === TutorialKind.Tutorial ? (
<Paper sx={{ p: 4, pt: 3 }}>
<Paper sx={{ p: 2, pt: 2 }}>
<DocItemContent>{children}</DocItemContent>
</Paper>
) : (
Expand Down
6 changes: 4 additions & 2 deletions src/theme/DocPage/Layout/Main/Paginators.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ export const Paginators: React.FC<{
prev: Step | null
setActiveStep: (step: Step) => void
isMobile?: boolean
}> = ({ next, prev, setActiveStep, isMobile = false }) => {
className?: string
}> = ({ next, prev, setActiveStep, isMobile = false, className }) => {
return (
<Box
className={className}
sx={{
display: 'flex',
width: '100%',
Expand Down Expand Up @@ -51,7 +53,7 @@ export const Paginators: React.FC<{
</Grid>
)}
</Grid>
{!isMobile && <Box className="col col--3"></Box>}

</Box>
)
}
21 changes: 13 additions & 8 deletions src/theme/DocPage/Layout/Main/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ const TutorialDocPageLayout: FC<Props> = ({
return (
<main
className={clsx(
'tutorial-doc-page',
'tutorial-doc-page', 'flex', 'w-full',
styles.docMainContainer,
(hiddenSidebarContainer || !sidebar) && styles.docMainContainerEnhanced
)}
Expand Down Expand Up @@ -218,11 +218,12 @@ const TutorialDocPageLayoutMobile: FC<{
}> = ({ children, meta, steps, activeStep, setActiveStep, next, prev }) => {
return (
<Grid
sx={{ m: 2, mt: 0 }}
sx={{ m: 0, mt: 0 }}
rowSpacing={2}
container
direction="column"
wrap="nowrap"
className='p-4'
>
<Grid item>
<Header title={meta?.title || ''} label={meta?.label || ''} />
Expand All @@ -235,8 +236,11 @@ const TutorialDocPageLayoutMobile: FC<{
isMobile
/>
</Grid>
<Grid item>{children}</Grid>

<Grid item>{children}
<Paginators next={next} prev={prev} setActiveStep={setActiveStep} />
</Grid>

</Grid>
)
}
Expand All @@ -251,24 +255,25 @@ const TutorialDocPageLayoutDesktop: FC<{
prev: Step | null
}> = ({ children, meta, steps, activeStep, setActiveStep, next, prev }) => {
return (
<Grid container sx={{ m: 3, width: '100%' }} columnSpacing={5}>
<Grid container sx={{width: '100%' }} columnSpacing={1} className='px-4 py-8'>
<Grid container item direction="column">
<Grid item>
<Header title={meta?.title || ''} label={meta?.label || ''} />
</Grid>
<Grid container item wrap="nowrap" columnGap={5}>
<Grid item xs={3} sx={{ minWidth: '250px' }}>
<Grid container item wrap="nowrap" columnGap={3}>
<Grid item xs={2} sx={{ minWidth: '240px' }}>
<Steps
steps={steps}
activeStep={activeStep}
setActiveStep={setActiveStep}
/>
</Grid>
<Grid container item xs={8}>
<Grid container item xs={9}>
<Grid sx={{ width: '100%' }} item>
{children}
<Paginators className="max-w-[75%]" next={next} prev={prev} setActiveStep={setActiveStep} />
</Grid>
<Paginators next={next} prev={prev} setActiveStep={setActiveStep} />

</Grid>
</Grid>
</Grid>
Expand Down