|
- {title}
+ {title}
|
{location.join(" > ")} |
diff --git a/src/components/Type.astro b/src/components/Type.astro
index 1f18743c5f0b0a..9f36a01f8c6650 100644
--- a/src/components/Type.astro
+++ b/src/components/Type.astro
@@ -15,7 +15,6 @@ const { text } = props.parse(Astro.props);
;
const props = z.object({
@@ -18,9 +20,7 @@ const data = await getEntries(products);
{
data.map((product) => (
-
- {product.data.product.title}
-
+
))
}
diff --git a/src/components/fields/FieldBadges.tsx b/src/components/fields/FieldBadges.tsx
index 4739f088cde421..16cc2c0c5036fb 100644
--- a/src/components/fields/FieldBadges.tsx
+++ b/src/components/fields/FieldBadges.tsx
@@ -1,12 +1,9 @@
const FieldBadges = ({ badges }: { badges: string[] }) => {
return (
-
+
{badges.map((badge) => (
- -
- {badge}
+
-
+ {badge}
))}
diff --git a/src/components/index.ts b/src/components/index.ts
index a52dbcbc622eac..39f2dc7a22ee72 100644
--- a/src/components/index.ts
+++ b/src/components/index.ts
@@ -7,6 +7,7 @@ export { Icon as AstroIcon } from "astro-icon/components";
// Custom components
export { default as AnchorHeading } from "./AnchorHeading.astro";
export { default as AvailableNotifications } from "./AvailableNotifications.astro";
+export { default as CompatibilityFlag } from "./CompatibilityFlag.astro";
export { default as CompatibilityFlags } from "./CompatibilityFlags.astro";
export { default as Description } from "./Description.astro";
export { default as Details } from "./Details.astro";
@@ -24,7 +25,6 @@ export { default as GlossaryTooltip } from "./GlossaryTooltip.astro";
export { default as HomepageHero } from "./HomepageHero.astro";
export { default as InlineBadge } from "./InlineBadge.astro";
export { default as LastReviewed } from "./LastReviewed.astro";
-export { default as LearningPath } from "./LearningPath.astro";
export { default as LinkTitleCard } from "./LinkTitleCard.astro";
export { default as ListExamples } from "./ListExamples.astro";
export { default as ListTutorials } from "./ListTutorials.astro";
diff --git a/src/components/models/ModelBadges.tsx b/src/components/models/ModelBadges.tsx
index 7da99cd2772537..5392cd5cede048 100644
--- a/src/components/models/ModelBadges.tsx
+++ b/src/components/models/ModelBadges.tsx
@@ -30,13 +30,10 @@ const ModelBadges = ({ model }: { model: WorkersAIModelsSchema }) => {
});
return (
-
+
{badges.map((badge) => (
- -
- {badge.text}
+
-
+ {badge.text}
))}
diff --git a/src/components/overrides/Footer.astro b/src/components/overrides/Footer.astro
index 56e0a8b90afd0f..eb9f481c97b12d 100644
--- a/src/components/overrides/Footer.astro
+++ b/src/components/overrides/Footer.astro
@@ -68,8 +68,7 @@ const homepageLegalLinks = Object.entries({
Trademark: "https://www.cloudflare.com/trademark/",
});
-const isHomepage =
- Astro.props.siteTitleHref === "/" && Astro.props.id === ".md";
+const isHomepage = Astro.props.id === "";
let isProduction = false;
diff --git a/src/components/overrides/Head.astro b/src/components/overrides/Head.astro
index 6afc5b959e000e..fc03560d421e9b 100644
--- a/src/components/overrides/Head.astro
+++ b/src/components/overrides/Head.astro
@@ -5,7 +5,6 @@ import { differenceInCalendarDays } from "date-fns";
import "tippy.js/dist/tippy.css";
import { getEntry } from "astro:content";
-import { getPageDescription } from "~/util/description";
const currentSection = Astro.url.pathname.split("/")[1];
@@ -139,14 +138,7 @@ if (currentSection) {
}
}
-Astro.props.entry.data.description = await getPageDescription(
- // @ts-expect-error TODO: improve types
- Astro.props.entry,
- Astro.locals,
-);
-
// Adding metadata used for reporting and search indexing
-
// content type
if (Astro.props.entry.data.pcx_content_type) {
const contentType = Astro.props.entry.data.pcx_content_type;
diff --git a/src/components/overrides/Hero.astro b/src/components/overrides/Hero.astro
index 5d07da91036d7f..33a3d554439c03 100644
--- a/src/components/overrides/Hero.astro
+++ b/src/components/overrides/Hero.astro
@@ -3,8 +3,7 @@ import type { Props } from "@astrojs/starlight/props";
import Default from "@astrojs/starlight/components/Hero.astro";
import HomepageHero from "../HomepageHero.astro";
-const isHomepage =
- Astro.props.siteTitleHref === "/" && Astro.props.id === ".md";
+const isHomepage = Astro.props.id === "";
---
{isHomepage ? : }
diff --git a/src/components/overrides/LastUpdated.astro b/src/components/overrides/LastUpdated.astro
deleted file mode 100644
index d271e81e82dcf1..00000000000000
--- a/src/components/overrides/LastUpdated.astro
+++ /dev/null
@@ -1,12 +0,0 @@
----
-import type { Props } from "@astrojs/starlight/props";
-import Default from "@astrojs/starlight/components/LastUpdated.astro";
-
-// Disable lastUpdated in footer if `updated` is present,
-// since this will show the date in PageTitle.astro instead.
-if (Astro.props.entry.data.updated) {
- Astro.props.lastUpdated = undefined;
-}
----
-
-
diff --git a/src/components/overrides/Page.astro b/src/components/overrides/Page.astro
new file mode 100644
index 00000000000000..7b40953d4c0b0f
--- /dev/null
+++ b/src/components/overrides/Page.astro
@@ -0,0 +1,64 @@
+---
+import type { Props } from "@astrojs/starlight/props";
+import Default from "@astrojs/starlight/components/Page.astro";
+
+import { generateDescription, generateTableOfContents } from "~/util/props";
+import { getSidebar, flattenSidebar, type SidebarEntry } from "~/util/sidebar";
+
+type Group = Extract;
+
+const props = Astro.props;
+const data = props.entry.data;
+
+const html = await Astro.slots.render("default");
+
+if (props.toc) {
+ props.toc.items = await generateTableOfContents(html);
+}
+
+if (props.hasSidebar) {
+ (props.sidebar as unknown as Group) = await getSidebar(Astro);
+
+ if (props.pagination) {
+ const flattened = flattenSidebar(
+ props.sidebar.entries as unknown as SidebarEntry[],
+ );
+
+ const idx = flattened.findIndex((entry) => entry.isCurrent);
+
+ let prev = flattened[idx - 1];
+ let next = flattened[idx + 1];
+
+ if (prev?.attrs["data-group-label"]) {
+ prev = {
+ ...prev,
+ label: prev.attrs["data-group-label"],
+ };
+ }
+
+ if (next?.attrs["data-group-label"]) {
+ next = {
+ ...next,
+ label: next.attrs["data-group-label"],
+ };
+ }
+
+ props.pagination.prev = prev;
+ props.pagination.next = next;
+ }
+}
+
+if (data.description) {
+ data.description = await generateDescription({
+ markdown: data.description,
+ });
+} else {
+ data.description = await generateDescription({ html });
+}
+
+if (data.updated) {
+ data.lastUpdated = undefined;
+}
+---
+
+
diff --git a/src/components/overrides/PageSidebar.astro b/src/components/overrides/PageSidebar.astro
deleted file mode 100644
index 7a3d2ad9de9979..00000000000000
--- a/src/components/overrides/PageSidebar.astro
+++ /dev/null
@@ -1,82 +0,0 @@
----
-import type { Props } from "@astrojs/starlight/props";
-import Default from "@astrojs/starlight/components/PageSidebar.astro";
-import type { CollectionEntry } from "astro:content";
-import { entryToString } from "~/util/container";
-import { parse } from "node-html-parser";
-import he from "he";
-
-let rangeBetween = (x: number, y: number) =>
- Array.from({ length: y - x + 1 }, (_, i) => i + x);
-
-if (Astro.props.toc) {
- const text = await entryToString(
- Astro.props.entry as CollectionEntry<"docs">,
- Astro.locals,
- );
-
- if (text) {
- const html = parse(text);
-
- // Currently unsupported to have maxHeadingLevel > 3.
- if (Astro.props.toc.maxHeadingLevel > 3) {
- throw new Error(
- `[PageSidebar] A tableOfContents.maxHeadingLevel higher than 3 is currently unsupported.`,
- );
- }
-
- const levels = rangeBetween(
- Astro.props.toc.minHeadingLevel,
- Astro.props.toc.maxHeadingLevel,
- ).map((level) => `h${level}[id]`);
- const selector = levels.join();
-
- const headers = html.querySelectorAll(selector);
-
- if (headers) {
- function headerDepth(header: any) {
- return Number(header.rawTagName.slice(1));
- }
-
- Astro.props.toc.items = [
- {
- text: "Overview",
- slug: "_top",
- depth: 1,
- children: [],
- },
- ];
-
- for (const header of headers) {
- if (header.id === "footnote-label") continue;
-
- const depth = headerDepth(header);
-
- const title = he.decode(header.innerText);
-
- if (depth === 2) {
- Astro.props.toc.items.push({
- text: title,
- slug: header.id,
- depth,
- children: [],
- });
-
- continue;
- }
-
- Astro.props.toc.items.at(-1)?.children.push({
- text: title,
- slug: header.id,
- depth,
- children: [],
- });
- }
- }
- }
-}
----
-
-
-
-
diff --git a/src/components/overrides/PageTitle.astro b/src/components/overrides/PageTitle.astro
index 2cef29cdeb4aba..ebae832e5ba50b 100644
--- a/src/components/overrides/PageTitle.astro
+++ b/src/components/overrides/PageTitle.astro
@@ -6,8 +6,6 @@ import { marked } from "marked";
import { Breadcrumbs } from "astro-breadcrumbs";
import "astro-breadcrumbs/breadcrumbs.css";
-import { Badge } from "@astrojs/starlight/components";
-
import Description from "~/components/Description.astro";
import SpotlightAuthorDetails from "~/components/SpotlightAuthorDetails.astro";
import LastReviewed from "~/components/LastReviewed.astro";
@@ -16,7 +14,6 @@ import { getEntry } from "astro:content";
const spotlightDetails = Astro.props.entry.data.spotlight;
const updated = Astro.props.entry.data.updated;
-const badge = Astro.props.entry.data.sidebar?.badge;
const summary = Astro.props.entry.data.summary;
const slug = Astro.props.entry.slug;
@@ -58,8 +55,8 @@ for (let i = 0; i < segments.length; i++) {
let title = segments[i];
if (entry) {
title = entry.data.title;
- } else if (i + 1 === segments.length) {
- title = Astro.props.entry.data.title;
+ } else {
+ continue;
}
breadcrumbProps.crumbs.push({
@@ -97,8 +94,6 @@ const hideBreadcrumbs = Astro.props.hideBreadcrumbs;
{!hideTitle && }
-{badge && }
-
{updated && }
{
diff --git a/src/components/overrides/Sidebar.astro b/src/components/overrides/Sidebar.astro
index e470eccd9403c8..935fa4926f1995 100644
--- a/src/components/overrides/Sidebar.astro
+++ b/src/components/overrides/Sidebar.astro
@@ -3,198 +3,29 @@ import type { Props } from "@astrojs/starlight/props";
import Default from "@astrojs/starlight/components/Sidebar.astro";
import { Icon as AstroIcon } from "astro-icon/components";
-import { getEntry } from "astro:content";
-import { Badge } from "@astrojs/starlight/components";
-import type { ComponentProps, HTMLAttributes } from "astro/types";
+import { lookupProductTitle } from "~/util/sidebar";
-const { sidebar, slug } = Astro.props;
-
-interface Link {
- type: "link";
- label: string;
- href: string;
- isCurrent: boolean;
- badge: ComponentProps | undefined;
- attrs: HTMLAttributes<"a">;
- order: number;
-}
-type SidebarEntry = Link | Group;
-
-interface Group {
- type: "group";
- label: string;
- entries: SidebarEntry[];
- collapsed: boolean;
- badge: ComponentProps | undefined;
- order: number;
-}
-
-const currentSection = slug?.split("/")[0];
-
-let filtered = sidebar.filter(
- (x) => x.label.toLowerCase() === currentSection,
-)[0] as Group;
-
-if (currentSection === "learning-paths") {
- const module = slug.split("/")[1];
- filtered.entries = filtered.entries.filter(
- (x) => x.label.toLowerCase() === module,
- );
- filtered.entries = (filtered.entries[0] as Group).entries.filter(
- (x) => x.type === "group",
- );
-}
-
-if (!filtered.entries) {
- throw new Error(`[Sidebar] Failed to find entries for ${currentSection}`);
-}
-
-function sortGroup(a: SidebarEntry, b: SidebarEntry): number {
- const collator = new Intl.Collator("en");
-
- if (a.order !== b.order) return a.order - b.order;
-
- return collator.compare(a.label, b.label);
-}
-
-async function handleGroup(group: Group): Promise {
- const indexLink = group.entries.find(
- (x) => x.type === "link" && x.href.endsWith(`/${group.label}/`),
- ) as Link | undefined;
-
- if (!indexLink) {
- throw new Error(`Unable to find index link in group ${group.label}`);
- }
-
- const indexPage = await getEntry("docs", indexLink.href.slice(1, -1));
-
- if (!indexPage) {
- throw new Error(`Unable to find index page with href ${indexLink}`);
- }
-
- const frontmatter = indexPage.data;
-
- group.label = frontmatter.sidebar.group?.label ?? frontmatter.title;
- group.order = frontmatter.sidebar.order ?? Number.MAX_VALUE;
- group.badge = frontmatter.sidebar.group?.badge;
-
- if (frontmatter.hideChildren) {
- return {
- type: "link",
- href: indexLink.href,
- label: group.label,
- order: group.order,
- attrs: {},
- isCurrent: Astro.url.pathname.startsWith(indexLink.href),
- } as Link;
- }
-
- for (const entry of group.entries.keys()) {
- if (group.entries[entry].type === "group") {
- group.entries[entry] = await handleGroup(group.entries[entry] as Group);
- } else {
- group.entries[entry] = await handleLink(group.entries[entry] as Link);
- }
- }
-
- group.entries = group.entries.sort(sortGroup);
-
- const indexIdx = group.entries.findIndex(
- (x) =>
- x.type === "link" &&
- [indexLink.href, frontmatter.external_link].includes(x.href),
- ) as number;
-
- if (indexPage.data.sidebar.group?.hideIndex) {
- group.entries.splice(indexIdx, 1);
- return group;
- }
-
- group.entries.unshift(group.entries.splice(indexIdx, 1)[0]);
- group.entries[0].label = indexPage.data.sidebar.label ?? "Overview";
-
- return group;
-}
-
-async function handleLink(link: Link): Promise {
- const slug = link.href.slice(1, -1);
- const page = await getEntry("docs", slug);
-
- if (!page) {
- throw new Error(`Oops`);
- }
-
- const frontmatter = page.data;
- link.order = frontmatter.sidebar.order ?? Number.MAX_VALUE;
-
- if (slug === currentSection) {
- link.order = 0;
- }
-
- if (frontmatter.external_link) {
- return {
- ...link,
- label: link.label.concat(" ↗"),
- href: frontmatter.external_link,
- badge: frontmatter.external_link.startsWith("/api")
- ? {
- text: "API",
- }
- : undefined,
- };
- }
-
- return link;
-}
-
-filtered.entries = await Promise.all(
- filtered.entries.map((entry) => {
- if (entry.type === "group") {
- return handleGroup(entry);
- } else {
- return handleLink(entry);
- }
- }),
-);
-
-filtered.entries = filtered.entries.sort(sortGroup);
-
-filtered.entries[0].label = "Overview";
-
-const lookupProductTitle = async (slug: string) => {
- const segments = slug.split("/");
- const product = segments[0];
-
- if (product === "learning-paths") {
- const path = segments[1];
-
- const entryData = await getEntry("learning-paths", path);
-
- return `${entryData?.data?.title} (Learning Paths)`;
- }
-
- const entryData = await getEntry("products", product);
-
- return entryData?.data?.product?.title ?? "Unknown";
-};
+const [product, module] = Astro.url.pathname.split("/").slice(1, -1);
---
- {lookupProductTitle(slug)}
+ {lookupProductTitle(product, module)}
-
+
|