Skip to content

docs: tag cookbook categories as Reference on the examples page #3278

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
bartlomieju wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: tag cookbook categories as Reference on the examples page #3278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bc69a6
docs: add a Start here path and tag cookbook categories
bartlomieju Jun 15, 2026
2a6cac6
chore: re-trigger CI
bartlomieju Jun 15, 2026
a2e2b4f
docs: drop the Start here strip, keep cookbook Reference tags
bartlomieju Jun 17, 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
7 changes: 6 additions & 1 deletion _components/LandingPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ import {
} from "../examples/_components/LearningList.tsx";
import { TutorialIcon } from "../examples/_components/TutorialIcon.tsx";
import { VideoIcon } from "../examples/_components/VideoIcon.tsx";
import { featuredItems, sidebar } from "../examples/_data.ts";
import {
cookbookCategories,
featuredItems,
sidebar,
} from "../examples/_data.ts";

function FeaturedStar() {
return (
Expand Down Expand Up @@ -38,6 +42,7 @@ export default function LandingPage(
title={item.title}
items={item.items}
descriptions={descriptions}
isReference={cookbookCategories.includes(item.title)}
/>
);
},
Expand Down
9 changes: 8 additions & 1 deletion examples/_components/LearningList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,20 @@ export function LearningList(
title: string;
items: SidebarItem[];
descriptions?: Record<string, string>;
isReference?: boolean;
},
) {
const anchor = props.title.toLowerCase().replace(/\s+/g, "-");
return (
<section className="mb-10">
<h2 id={anchor} className="text-lg md:text-xl font-semibold mb-4 mt-0">
{props.title}&nbsp;
{props.title}
{props.isReference && (
<span className="ml-2 align-middle text-xs font-medium uppercase tracking-wide text-foreground-secondary border border-foreground-tertiary rounded px-1.5 py-0.5">
Reference
</span>
)}
&nbsp;
<a class="header-anchor" href={`#${anchor}`}>
<span class="sr-only">Jump to heading</span>
<span aria-hidden="true" class="anchor-end">#</span>
Expand Down
10 changes: 10 additions & 0 deletions examples/_data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2067,5 +2067,15 @@ export const featuredItems = [
},
];

// Categories that are copy-paste reference snippets rather than
// walkthrough-style guides. The landing page tags these as "Reference" so
// newcomers can tell them apart from tutorial-grade content.
export const cookbookCategories = [
"File system",
"System",
"Web standard APIs",
"Encoding",
];

export const sectionTitle = "Examples";
export const sectionHref = "/examples/";
Loading