Skip to content

Bring the workshop reader closer to the new gh-aw docs style #4181

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

Merged
pelikhan merged 2 commits into from
Oct 4, 2026
Merged

Bring the workshop reader closer to the new gh-aw docs style #4181

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
6368e8e
Align workshop reader with gh-aw docs palette and components
Copilot Oct 4, 2026
737db6c
Match browser chrome and cover docs reader colors
Copilot Oct 4, 2026
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
14 changes: 14 additions & 0 deletions scripts/build-docs.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,20 @@ test("workshop typography uses the bundled Mona Sans and fluid reading scale", (
assert.match(css, /\.markdown-body h3 \{[\s\S]*?font-weight: 600;/);
});

test("reader uses the gh-aw-inspired reading surface in both color schemes", () => {
const { html, css, alertsCss } = buildDocs();

assert.ok(html.includes('<meta name="theme-color" content="#fcfcfb"'));
assert.ok(html.includes('<meta name="theme-color" content="#0c0a09"'));
assert.match(css, /--workshop-page-bg: #fcfcfb;/);
assert.match(css, /--workshop-page-bg: #0c0a09;/);
assert.match(css, /--workshop-link-color: #5f489a;/);
assert.match(css, /--workshop-link-color: #c3b5e4;/);
assert.match(css, /\.markdown-body > details \{[^}]*max-width: 760px;/);
assert.match(css, /\.workshop-navigation \{[^}]*border-top: 1px solid var\(--workshop-divider\);/);
assert.match(alertsCss, /\.markdown-alert \{[^}]*border: 1px solid color-mix\(/);
});

test("workshop navigation constrains long buttons on small screens", () => {
const { css } = buildDocs();

Expand Down
46 changes: 28 additions & 18 deletions scripts/lib/alerts.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
/* Alert callout styles for GitHub GFM > [!NOTE] / [!TIP] / etc. */
.markdown-alert {
padding: 0.5rem 1rem;
padding: 1.25rem;
margin-bottom: 16px;
border-left: 0.25em solid;
border-radius: 6px;
border: 1px solid color-mix(in srgb, var(--workshop-alert-color) 16%, var(--workshop-page-bg));
border-radius: 12px;
background-color: color-mix(in srgb, var(--workshop-alert-color) 5%, var(--workshop-page-bg));
color: var(--workshop-text);
}
.markdown-alert > :first-child { margin-top: 0; }
.markdown-alert > :last-child { margin-bottom: 0; }
Expand All @@ -17,27 +19,35 @@
}
.markdown-alert-title svg { margin-right: 8px; }
.markdown-alert-note {
border-color: var(--borderColor-accent-emphasis, #0969da);
background-color: var(--bgColor-accent-muted, #ddf4ff);
--workshop-alert-color: #0969da;
}
.markdown-alert-note .markdown-alert-title { color: var(--fgColor-accent, #0969da); }
.markdown-alert-note .markdown-alert-title { color: var(--workshop-alert-color); }
.markdown-alert-tip {
border-color: var(--borderColor-success-emphasis, #1a7f37);
background-color: var(--bgColor-success-muted, #dafbe1);
--workshop-alert-color: #1a7f37;
}
.markdown-alert-tip .markdown-alert-title { color: var(--fgColor-success, #1a7f37); }
.markdown-alert-tip .markdown-alert-title { color: var(--workshop-alert-color); }
.markdown-alert-important {
border-color: var(--borderColor-done-emphasis, #8250df);
background-color: var(--bgColor-done-muted, #fbefff);
--workshop-alert-color: #5f489a;
}
.markdown-alert-important .markdown-alert-title { color: var(--fgColor-done, #8250df); }
.markdown-alert-important .markdown-alert-title { color: var(--workshop-alert-color); }
.markdown-alert-warning {
border-color: var(--borderColor-attention-emphasis, #9a6700);
background-color: var(--bgColor-attention-muted, #fff8c5);
--workshop-alert-color: #9a6700;
}
.markdown-alert-warning .markdown-alert-title { color: var(--fgColor-attention, #9a6700); }
.markdown-alert-warning .markdown-alert-title { color: var(--workshop-alert-color); }
.markdown-alert-caution {
border-color: var(--borderColor-danger-emphasis, #d1242f);
background-color: var(--bgColor-danger-muted, #ffebe9);
--workshop-alert-color: #cf222e;
}
.markdown-alert-caution .markdown-alert-title { color: var(--fgColor-danger, #d1242f); }
.markdown-alert-caution .markdown-alert-title { color: var(--workshop-alert-color); }

@media (prefers-color-scheme: dark) {
html[data-color-mode="auto"] .markdown-alert-note { --workshop-alert-color: #75cfff; }
html[data-color-mode="auto"] .markdown-alert-tip { --workshop-alert-color: #7dd54d; }
html[data-color-mode="auto"] .markdown-alert-important { --workshop-alert-color: #c3b5e4; }
html[data-color-mode="auto"] .markdown-alert-warning { --workshop-alert-color: #eaa734; }
html[data-color-mode="auto"] .markdown-alert-caution { --workshop-alert-color: #ff554d; }
}
html[data-color-mode="dark"] .markdown-alert-note { --workshop-alert-color: #75cfff; }
html[data-color-mode="dark"] .markdown-alert-tip { --workshop-alert-color: #7dd54d; }
html[data-color-mode="dark"] .markdown-alert-important { --workshop-alert-color: #c3b5e4; }
html[data-color-mode="dark"] .markdown-alert-warning { --workshop-alert-color: #eaa734; }
html[data-color-mode="dark"] .markdown-alert-caution { --workshop-alert-color: #ff554d; }
140 changes: 67 additions & 73 deletions scripts/lib/docs.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
/* Improve link discoverability in rendered workshop docs */
:root {
--workshop-sticky-header-offset: 72px;
--workshop-link-color: var(--fgColor-accent, #0969da);
--workshop-link-visited-color: var(--fgColor-done, #8250df);
--workshop-link-hover-color: var(--fgColor-accent, #0550ae);
--workshop-page-bg: #fcfcfb;
--workshop-surface: #ffffff;
--workshop-surface-muted: #f5f5f4;
--workshop-text: #1c1917;
--workshop-text-muted: #57534e;
--workshop-divider: #e7e5e4;
--workshop-link-color: #5f489a;
--workshop-link-visited-color: #4b397a;
--workshop-link-hover-color: #4b397a;
--workshop-type-body: clamp(1rem, 0.955rem + 0.227vw, 1.125rem);
--workshop-type-title: clamp(2.25rem, 1.977rem + 1.364vw, 3rem);
--workshop-type-section: clamp(1.75rem, 1.477rem + 1.364vw, 2.5rem);
Expand All @@ -12,16 +18,28 @@

@media (prefers-color-scheme: dark) {
html[data-color-mode="auto"] {
--workshop-link-color: var(--fgColor-accent, #58a6ff);
--workshop-link-visited-color: var(--fgColor-done, #bc8cff);
--workshop-link-hover-color: var(--fgColor-accent, #79c0ff);
--workshop-page-bg: #0c0a09;
--workshop-surface: #231f1c;
--workshop-surface-muted: #1c1917;
--workshop-text: #fcfcfb;
--workshop-text-muted: #d6d3d1;
--workshop-divider: #44403c;
--workshop-link-color: #c3b5e4;
--workshop-link-visited-color: #e0d8f1;
--workshop-link-hover-color: #e0d8f1;
}
}

html[data-color-mode="dark"] {
--workshop-link-color: var(--fgColor-accent, #58a6ff);
--workshop-link-visited-color: var(--fgColor-done, #bc8cff);
--workshop-link-hover-color: var(--fgColor-accent, #79c0ff);
--workshop-page-bg: #0c0a09;
--workshop-surface: #231f1c;
--workshop-surface-muted: #1c1917;
--workshop-text: #fcfcfb;
--workshop-text-muted: #d6d3d1;
--workshop-divider: #44403c;
--workshop-link-color: #c3b5e4;
--workshop-link-visited-color: #e0d8f1;
--workshop-link-hover-color: #e0d8f1;
}

body,
Expand All @@ -30,6 +48,10 @@ body,
font-optical-sizing: auto;
font-variant-ligatures: none;
}
body {
background-color: var(--workshop-page-bg);
color: var(--workshop-text);
}

html {
scroll-padding-top: var(--workshop-sticky-header-offset);
Expand All @@ -45,9 +67,9 @@ html {
justify-content: space-between;
min-height: 56px;
padding: 0 16px;
color: var(--fgColor-default, #1f2328);
background-color: var(--bgColor-default, #ffffff);
border-bottom: 1px solid var(--borderColor-muted, #d0d7de);
color: var(--workshop-text);
background-color: var(--workshop-page-bg);
border-bottom: 1px solid var(--workshop-divider);
}
.site-title {
margin: 0;
Expand Down Expand Up @@ -198,10 +220,10 @@ html[data-color-mode="dark"] .menu-toggle-progress {
max-height: none;
margin: 0;
padding: 0;
color: var(--fgColor-default, #1f2328);
background-color: var(--bgColor-default, #ffffff);
color: var(--workshop-text);
background-color: var(--workshop-page-bg);
border: 0;
border-right: 1px solid var(--borderColor-muted, #d0d7de);
border-right: 1px solid var(--workshop-divider);
}
.workshop-menu::backdrop {
background: rgba(0, 0, 0, 0.48);
Expand Down Expand Up @@ -267,13 +289,15 @@ html[data-color-mode="dark"] .menu-toggle-progress {
background-color: var(--bgColor-muted, #f6f8fa);
}
.workshop-menu-group a[aria-current="page"] {
color: var(--workshop-link-color);
color: var(--workshop-text);
font-weight: 600;
background-color: var(--bgColor-accent-muted, #ddf4ff);
background-color: var(--workshop-surface-muted);
}

.markdown-body > details {
scroll-margin-top: var(--workshop-sticky-header-offset);
max-width: 760px;
margin-inline: auto;
}
.markdown-body details > summary {
display: inline-flex;
Expand Down Expand Up @@ -302,6 +326,10 @@ html[data-color-mode="dark"] .menu-toggle-progress {
margin-inline: auto;
padding-inline: 20px !important;
}
.markdown-body {
color: var(--workshop-text);
background-color: transparent;
}

.markdown-body p,
.markdown-body li {
Expand All @@ -316,13 +344,24 @@ html[data-color-mode="dark"] .menu-toggle-progress {
font-size: var(--workshop-type-section);
font-weight: 400;
line-height: 1.2;
border-bottom: 0;
}
.markdown-body h3 {
max-width: 24ch;
font-size: var(--workshop-type-subheading);
font-weight: 600;
line-height: 1.3;
}

.markdown-body > details > .workshop-page-title {
margin-bottom: 24px;
}
.markdown-body h2:not(.workshop-page-title) {
margin-top: 48px;
}
.markdown-body h3 {
margin-top: 32px;
}
.markdown-body h4,
.markdown-body h5,
.markdown-body h6 {
Expand Down Expand Up @@ -551,8 +590,8 @@ body > footer a {
align-items: flex-start;
gap: 16px;
margin-top: 32px;
padding-top: 16px;
border-top: 1px solid var(--borderColor-muted, #d0d7de);
padding-top: 24px;
border-top: 1px solid var(--workshop-divider);
}
.workshop-navigation-previous {
flex: 0 0 auto;
Expand Down Expand Up @@ -586,69 +625,24 @@ body > footer a {
text-decoration: none;
}
.workshop-nav-btn-primary {
color: #ffffff;
background-color: var(--bgColor-accent-emphasis, #0969da);
color: var(--workshop-link-color);
background-color: transparent;
border: 1px solid transparent;
}
.workshop-nav-btn-primary:hover,
.workshop-nav-btn-primary:focus-visible {
color: #ffffff;
background-color: var(--bgColor-accent-emphasis, #0550ae);
filter: brightness(0.9);
color: var(--workshop-link-hover-color);
background-color: var(--workshop-surface-muted);
}
.workshop-nav-btn-secondary {
color: var(--fgColor-default, #1f2328);
background-color: var(--bgColor-muted, #f6f8fa);
border: 1px solid var(--borderColor-default, #d0d7de);
color: var(--workshop-text-muted);
background-color: transparent;
border: 1px solid transparent;
}
.workshop-nav-btn-secondary:hover,
.workshop-nav-btn-secondary:focus-visible {
color: var(--fgColor-default, #1f2328);
background-color: var(--bgColor-subtle, #eaeef2);
}

@media (prefers-color-scheme: dark) {
html[data-color-mode="auto"] .workshop-nav-btn-primary {
background-color: var(--bgColor-accent-emphasis, #1f6feb);
color: #ffffff;
}
html[data-color-mode="auto"] .workshop-nav-btn-primary:hover,
html[data-color-mode="auto"] .workshop-nav-btn-primary:focus-visible {
background-color: var(--bgColor-accent-emphasis, #1f6feb);
color: #ffffff;
filter: brightness(0.9);
}
html[data-color-mode="auto"] .workshop-nav-btn-secondary {
color: var(--fgColor-default, #e6edf3);
background-color: var(--bgColor-muted, #161b22);
border-color: var(--borderColor-default, #30363d);
}
html[data-color-mode="auto"] .workshop-nav-btn-secondary:hover,
html[data-color-mode="auto"] .workshop-nav-btn-secondary:focus-visible {
color: var(--fgColor-default, #e6edf3);
background-color: var(--bgColor-subtle, #1c2128);
}
}

html[data-color-mode="dark"] .workshop-nav-btn-primary {
background-color: var(--bgColor-accent-emphasis, #1f6feb);
color: #ffffff;
}
html[data-color-mode="dark"] .workshop-nav-btn-primary:hover,
html[data-color-mode="dark"] .workshop-nav-btn-primary:focus-visible {
background-color: var(--bgColor-accent-emphasis, #1f6feb);
color: #ffffff;
filter: brightness(0.9);
}
html[data-color-mode="dark"] .workshop-nav-btn-secondary {
color: var(--fgColor-default, #e6edf3);
background-color: var(--bgColor-muted, #161b22);
border-color: var(--borderColor-default, #30363d);
}
html[data-color-mode="dark"] .workshop-nav-btn-secondary:hover,
html[data-color-mode="dark"] .workshop-nav-btn-secondary:focus-visible {
color: var(--fgColor-default, #e6edf3);
background-color: var(--bgColor-subtle, #1c2128);
color: var(--workshop-text);
background-color: var(--workshop-surface-muted);
}

@media (max-width: 799px) {
Expand Down
4 changes: 2 additions & 2 deletions scripts/lib/page-template.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ function generatePage(htmlContent, workshopMenu) {
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="color-scheme" content="light dark">
<meta name="theme-color" content="#ffffff" media="(prefers-color-scheme: light)">
<meta name="theme-color" content="#0d1117" media="(prefers-color-scheme: dark)">
<meta name="theme-color" content="#fcfcfb" media="(prefers-color-scheme: light)">
<meta name="theme-color" content="#0c0a09" media="(prefers-color-scheme: dark)">
<title>${SITE_TITLE}</title>
<meta name="description" content="${SITE_DESCRIPTION}">
<!-- Open Graph -->
Expand Down