🔢 Add enumerators to page titles and toc (#525)

jupyter-book · Jan 29, 2025 · e65d974 · e65d974
1 parent c2db8fb
commit e65d974
Show file tree

Hide file tree

Showing 17 changed files with 352 additions and 323 deletions.
diff --git a/.changeset/itchy-cows-run.md b/.changeset/itchy-cows-run.md
@@ -0,0 +1,7 @@
+---
+'@myst-theme/frontmatter': patch
+'@myst-theme/common': patch
+'@myst-theme/site': patch
+---
+
+Add enumerators to page titles and toc
diff --git a/.changeset/twelve-avocados-perform.md b/.changeset/twelve-avocados-perform.md
@@ -0,0 +1,11 @@
+---
+'myst-to-react': patch
+'myst-demo': patch
+'@myst-theme/providers': patch
+'@myst-theme/jupyter': patch
+'@myst-theme/article': patch
+'@myst-theme/site': patch
+'@myst-theme/book': patch
+---
+
+Bump all myst and thebe package versions
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -27,8 +27,8 @@
     "version": "changeset version && npm install",
     "publish": "npm run clean && npm run build -- --force && changeset publish && git push --follow-tags",
     "publish:ci": "npm run clean && npm run build && changeset publish && git push --follow-tags",
-    "bump:myst:packages": "npx npm-upgrade-monorepo -w 'packages/*' 'myst-* @myst-theme/*'",
-    "bump:myst:themes": "npx npm-upgrade-monorepo -w 'themes/*' 'myst-* @myst-theme/*'",
+    "bump:myst:packages": "npx npm-upgrade-monorepo -w 'packages/*' 'myst-* @myst-theme/* thebe*'",
+    "bump:myst:themes": "npx npm-upgrade-monorepo -w 'themes/*' 'myst-* @myst-theme/* thebe*'",
     "bump:myst": "npm run bump:myst:packages && npm run bump:myst:themes"
   },
   "devDependencies": {

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -19,9 +19,9 @@
     "build": "npm-run-all -l clean -p build:esm"
   },
   "dependencies": {
-    "myst-common": "^1.7.3",
-    "myst-config": "^1.7.3",
-    "myst-spec-ext": "^1.7.3",
+    "myst-common": "^1.7.8",
+    "myst-config": "^1.7.8",
+    "myst-spec-ext": "^1.7.8",
     "nbtx": "^0.2.3",
     "unist-util-select": "^4.0.3"
   }

diff --git a/packages/common/src/types.ts b/packages/common/src/types.ts
@@ -20,6 +20,7 @@ export type Heading = {
   short_title?: string;
   level: number | 'index';
   group?: string;
+  enumerator?: string;
 };
 
 export type SiteLoader = {

diff --git a/packages/common/src/utils.ts b/packages/common/src/utils.ts
@@ -38,6 +38,7 @@ export function getProjectHeadings(
       slug: project.index,
       path: project.slug ? `/${project.slug}` : '/',
       level: 'index',
+      enumerator: project.enumerator,
     },
     ...project.pages.map((p) => {
       if (!('slug' in p)) return p;

diff --git a/packages/frontmatter/src/FrontmatterBlock.tsx b/packages/frontmatter/src/FrontmatterBlock.tsx
@@ -223,6 +223,7 @@ export function FrontmatterBlock({
     downloads,
     date,
     authors,
+    enumerator,
   } = frontmatter;
   const isJupyter = kind === SourceFileKind.Notebook;
   const hasExports = downloads ? downloads.length > 0 : exports && exports.length > 0;
@@ -277,7 +278,12 @@ export function FrontmatterBlock({
           {!hideLaunch && thebe && location && <LaunchButton thebe={thebe} location={location} />}
         </div>
       )}
-      {title && <h1 className="mb-0">{title}</h1>}
+      {title && (
+        <h1 className="mb-0">
+          {enumerator && <span className="mr-3 select-none">{enumerator}</span>}
+          {title}
+        </h1>
+      )}
       {subtitle && <p className="mt-2 mb-0 lead text-zinc-600 dark:text-zinc-400">{subtitle}</p>}
       {hasAuthors && authorStyle === 'list' && (
         <AuthorsList authors={frontmatter.authors} affiliations={frontmatter.affiliations} />

diff --git a/packages/jupyter/package.json b/packages/jupyter/package.json
@@ -30,19 +30,19 @@
     "buffer": "^6.0.3",
     "classnames": "^2.5.1",
     "jupyterlab-plotly": "^5.24.0",
-    "myst-common": "^1.7.3",
-    "myst-config": "^1.7.3",
-    "myst-frontmatter": "^1.7.3",
+    "myst-common": "^1.7.8",
+    "myst-config": "^1.7.8",
+    "myst-frontmatter": "^1.7.8",
     "myst-spec": "^0.0.5",
-    "myst-spec-ext": "^1.7.3",
+    "myst-spec-ext": "^1.7.8",
     "myst-to-react": "^0.13.5",
     "nanoid": "^4.0.2",
     "nbtx": "^0.2.3",
     "react-syntax-highlighter": "^15.5.0",
     "swr": "^2.1.5",
-    "thebe-core": "0.4.10",
-    "thebe-lite": "0.4.10",
-    "thebe-react": "0.4.10",
+    "thebe-core": "0.5.0",
+    "thebe-lite": "0.5.0",
+    "thebe-react": "0.5.0",
     "unist-util-select": "^4.0.3"
   },
   "peerDependencies": {

diff --git a/packages/myst-demo/package.json b/packages/myst-demo/package.json
@@ -23,25 +23,25 @@
     "@heroicons/react": "^2.0.18",
     "classnames": "^2.3.2",
     "js-yaml": "^4.1.0",
-    "myst-common": "^1.7.3",
-    "myst-config": "^1.7.3",
-    "myst-directives": "^1.5.7",
-    "myst-ext-button": "^0.0.0",
+    "myst-common": "^1.7.8",
+    "myst-config": "^1.7.8",
+    "myst-directives": "^1.5.11",
+    "myst-ext-button": "^0.0.1",
     "myst-ext-card": "^1.0.9",
-    "myst-ext-exercise": "^1.0.8",
-    "myst-ext-grid": "^1.0.8",
-    "myst-ext-proof": "^1.0.11",
-    "myst-ext-tabs": "^1.0.8",
-    "myst-frontmatter": "^1.7.3",
-    "myst-parser": "^1.5.7",
+    "myst-ext-exercise": "^1.0.9",
+    "myst-ext-grid": "^1.0.9",
+    "myst-ext-proof": "^1.0.12",
+    "myst-ext-tabs": "^1.0.9",
+    "myst-frontmatter": "^1.7.8",
+    "myst-parser": "^1.5.11",
     "myst-spec": "^0.0.5",
-    "myst-to-docx": "^1.0.12",
-    "myst-to-html": "^1.5.7",
-    "myst-to-jats": "^1.0.30",
+    "myst-to-docx": "^1.0.13",
+    "myst-to-html": "^1.5.11",
+    "myst-to-jats": "^1.0.32",
     "myst-to-react": "^0.13.5",
-    "myst-to-tex": "^1.0.38",
-    "myst-to-typst": "^0.0.25",
-    "myst-transforms": "^1.3.26",
+    "myst-to-tex": "^1.0.41",
+    "myst-to-typst": "^0.0.30",
+    "myst-transforms": "^1.3.31",
     "unified": "^10.1.2",
     "unist-util-remove": "^4.0.0",
     "unist-util-visit": "^4.1.2",

diff --git a/packages/myst-demo/src/index.tsx b/packages/myst-demo/src/index.tsx
@@ -158,7 +158,10 @@ async function parse(
     messages: {},
   });
   const state = new ReferenceState('', {
-    numbering: frontmatter.numbering ?? defaultFrontmatter?.numbering,
+    frontmatter: {
+      ...frontmatter,
+      numbering: frontmatter.numbering ?? defaultFrontmatter?.numbering,
+    },
     vfile,
   });
   visit(mdast, (n) => {

diff --git a/packages/myst-to-react/package.json b/packages/myst-to-react/package.json
@@ -26,8 +26,8 @@
     "@radix-ui/react-hover-card": "^1.0.6",
     "buffer": "^6.0.3",
     "classnames": "^2.3.2",
-    "myst-common": "^1.7.3",
-    "myst-config": "^1.7.3",
+    "myst-common": "^1.7.8",
+    "myst-config": "^1.7.8",
     "myst-spec": "^0.0.5",
     "nanoid": "^4.0.2",
     "react-syntax-highlighter": "15.5.0",

diff --git a/packages/providers/package.json b/packages/providers/package.json
@@ -27,9 +27,9 @@
   "peerDependencies": {
     "@types/react": "^16.8 || ^17.0 || ^18.0",
     "@types/react-dom": "^16.8 || ^17.0 || ^18.0",
-    "myst-common": "^1.7.3",
-    "myst-config": "^1.7.3",
-    "myst-frontmatter": "^1.7.3",
+    "myst-common": "^1.7.8",
+    "myst-config": "^1.7.8",
+    "myst-frontmatter": "^1.7.8",
     "react": "^16.8 || ^17.0 || ^18.0",
     "react-dom": "^16.8 || ^17.0 || ^18.0"
   },

diff --git a/packages/site/package.json b/packages/site/package.json
@@ -32,17 +32,17 @@
     "@radix-ui/react-visually-hidden": "^1.1.0",
     "classnames": "^2.3.2",
     "lodash.throttle": "^4.1.1",
-    "myst-common": "^1.7.3",
-    "myst-config": "^1.7.3",
+    "myst-common": "^1.7.8",
+    "myst-config": "^1.7.8",
     "myst-demo": "^0.13.5",
-    "myst-spec-ext": "^1.7.3",
+    "myst-spec-ext": "^1.7.8",
     "myst-to-react": "^0.13.5",
     "nbtx": "^0.2.3",
     "node-cache": "^5.1.2",
     "node-fetch": "^2.6.11",
     "react-merge-refs": "^2.1.1",
     "string.prototype.matchall": "^4.0.11",
-    "thebe-react": "0.4.10",
+    "thebe-react": "0.5.0",
     "unist-util-select": "^4.0.1"
   },
   "peerDependencies": {

diff --git a/packages/site/src/components/Navigation/TableOfContentsItems.tsx b/packages/site/src/components/Navigation/TableOfContentsItems.tsx
@@ -78,20 +78,20 @@ function LinkItem({
   if (!heading.path) {
     return (
       <div
-        title={heading.title}
+        title={`${heading.enumerator ? `${heading.enumerator} ` : ''}${heading.title}`}
         className={classNames('block break-words rounded', className)}
         onClick={() => {
           onClick?.();
         }}
       >
-        {heading.short_title || heading.title}
+        {`${heading.enumerator ? `${heading.enumerator} ` : ''}${heading.short_title || heading.title}`}
       </div>
     );
   }
   return (
     <NavLink
       prefetch="intent"
-      title={heading.title}
+      title={`${heading.enumerator ? `${heading.enumerator} ` : ''}${heading.title}`}
       className={classNames(
         'block break-words focus:outline outline-blue-200 outline-2 rounded',
         className,
@@ -102,7 +102,7 @@ function LinkItem({
         setOpen(false);
       }}
     >
-      {heading.short_title || heading.title}
+      {`${heading.enumerator ? `${heading.enumerator} ` : ''}${heading.short_title || heading.title}`}
     </NavLink>
   );
 }

diff --git a/themes/article/package.json b/themes/article/package.json
@@ -25,8 +25,8 @@
     "@remix-run/node": "~1.17.0",
     "@remix-run/react": "~1.17.0",
     "@remix-run/vercel": "~1.17.0",
-    "myst-common": "^1.7.3",
-    "myst-config": "^1.7.3",
+    "myst-common": "^1.7.8",
+    "myst-config": "^1.7.8",
     "node-fetch": "^2.6.11",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/themes/book/package.json b/themes/book/package.json
@@ -25,8 +25,8 @@
     "@remix-run/node": "~1.17.0",
     "@remix-run/react": "~1.17.0",
     "@remix-run/vercel": "~1.17.0",
-    "myst-common": "^1.7.3",
-    "myst-config": "^1.7.3",
+    "myst-common": "^1.7.8",
+    "myst-config": "^1.7.8",
     "node-fetch": "^2.6.11",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"