Update knownParts function

jupyter-book · Oct 17, 2024 · 995fb41 · 995fb41
1 parent a03edd8
commit 995fb41
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 27 deletions.
diff --git a/packages/common/src/types.ts b/packages/common/src/types.ts
@@ -46,7 +46,7 @@ export type FooterLinks = {
 };
 
 type PageFrontmatterWithDownloads = Omit<PageFrontmatter, 'parts' | 'downloads' | 'exports'> & {
-  parts?: Record<string, GenericParent>;
+  parts?: Record<string, { frontmatter?: PageFrontmatter; mdast: GenericParent }>;
   downloads?: SiteAction[];
   exports?: SiteExport[];
 };

diff --git a/packages/site/src/pages/Article.tsx b/packages/site/src/pages/Article.tsx
@@ -42,14 +42,7 @@ export const ArticlePage = React.memo(function ({
   const downloads = combineDownloads(manifest?.downloads, article.frontmatter);
   const tree = copyNode(article.mdast);
   const keywords = article.frontmatter?.keywords ?? [];
-  const parts = {
-    ...extractKnownParts(tree),
-    ...Object.fromEntries(
-      Object.entries(article.frontmatter?.parts ?? {}).map(([k, v]) => {
-        return [k, v.mdast];
-      }),
-    ),
-  };
+  const parts = extractKnownParts(tree, article.frontmatter?.parts);
 
   return (
     <ReferencesProvider

diff --git a/packages/site/src/utils.ts b/packages/site/src/utils.ts
@@ -18,13 +18,21 @@ export type KnownParts = {
   acknowledgments?: GenericParent;
 };
 
-export function extractKnownParts(tree: GenericParent): KnownParts {
+export function extractKnownParts(
+  tree: GenericParent,
+  parts?: Record<string, { mdast?: GenericParent }>,
+): KnownParts {
   const abstract = extractPart(tree, 'abstract');
   const summary = extractPart(tree, 'summary', { requireExplicitPart: true });
   const keypoints = extractPart(tree, ['keypoints'], { requireExplicitPart: true });
   const data_availability = extractPart(tree, ['data_availability', 'data availability']);
   const acknowledgments = extractPart(tree, ['acknowledgments', 'acknowledgements']);
-  return { abstract, summary, keypoints, data_availability, acknowledgments };
+  const otherParts = Object.fromEntries(
+    Object.entries(parts ?? {}).map(([k, v]) => {
+      return [k, v.mdast];
+    }),
+  );
+  return { abstract, summary, keypoints, data_availability, acknowledgments, ...otherParts };
 }
 
 /**

diff --git a/themes/article/app/components/Article.tsx b/themes/article/app/components/Article.tsx
@@ -34,14 +34,7 @@ export function Article({
 }) {
   const keywords = article.frontmatter?.keywords ?? [];
   const tree = copyNode(article.mdast);
-  const parts = {
-    ...extractKnownParts(tree),
-    ...Object.fromEntries(
-      Object.entries(article.frontmatter?.parts ?? {}).map(([k, v]) => {
-        return [k, v.mdast];
-      }),
-    ),
-  };
+  const parts = extractKnownParts(tree, article.frontmatter?.parts);
   const { title, subtitle } = article.frontmatter;
   const compute = useComputeOptions();
   const top = useThemeTop();

diff --git a/themes/book/app/components/ArticlePage.tsx b/themes/book/app/components/ArticlePage.tsx
@@ -74,14 +74,7 @@ export const ArticlePage = React.memo(function ({
   const downloads = combineDownloads(manifest?.downloads, article.frontmatter);
   const tree = copyNode(article.mdast);
   const keywords = article.frontmatter?.keywords ?? [];
-  const parts = {
-    ...extractKnownParts(tree),
-    ...Object.fromEntries(
-      Object.entries(article.frontmatter?.parts ?? {}).map(([k, v]) => {
-        return [k, v.mdast];
-      }),
-    ),
-  };
+  const parts = extractKnownParts(tree, article.frontmatter?.parts);
   const isOutlineMargin = useMediaQuery('(min-width: 1024px)');
   return (
     <ReferencesProvider