👣 Allow custom primary sidebar footer

.changeset/stale-peas-lay.md

@@ -0,0 +1,6 @@
+---
+'@myst-theme/site': patch
+'@myst-theme/book': patch
+---
+
+Add project.parts.primary_sidebar_footer option

.gitignore

@@ -38,4 +38,4 @@ _build
 
 # yalc
 .yalc
-yalc.lock
+yalc.lock

docs/_site/primary_sidebar_footer.md

@@ -0,0 +1 @@
+**Custom Footer** | [GitHub](https://github.com/jupyter-book/myst-theme)

docs/myst.yml

@@ -11,6 +11,7 @@ project:
   parts:
     banner: _site/banner.md
     footer: _site/footer.md
+    primary_sidebar_footer: _site/primary_sidebar_footer.md
   toc:
     - file: index.md
     - file: examples.md

docs/ui.md

@@ -42,3 +42,23 @@ project:
 
 - Appears at the bottom of every page
 - Supports any MyST markdown content (links, formatting, etc.)
+
+## Sidebar Footer
+
+Display custom content at the bottom of the primary sidebar (table of contents).
+
+### Configuration
+
+Create a markdown file with your sidebar footer content and add it to `myst.yml`:
+
+```yaml
+project:
+  parts:
+    primary_sidebar_footer: _site/primary_sidebar_footer.md
+```
+
+### Behavior
+
+- Appears at the bottom of the primary sidebar (left-side navigation)
+- If the `.md` file it points to is empty, the footer will not be visible
+- If not configured, falls back to the default "Made with MyST" footer

themes/book/app/components/SidebarFooter.tsx

@@ -0,0 +1,15 @@
+import type { GenericParent } from 'myst-common';
+import { MyST } from 'myst-to-react';
+import { MadeWithMyst } from '@myst-theme/icons';
+
+export function SidebarFooter({ content }: { content?: GenericParent }) {
+  if (!content) {
+    return <MadeWithMyst />;
+  }
+
+  return (
+    <div className="article footer myst-primary-sidebar-footer">
+      <MyST ast={content} />
+    </div>
+  );
+}

themes/book/app/routes/$.tsx

@@ -31,6 +31,7 @@ import { MadeWithMyst } from '@myst-theme/icons';
 import { ArticlePage } from '../components/ArticlePage.js';
 import { Footer } from '../components/Footer.js';
 import { Banner } from '../components/Banner.js';
+import { SidebarFooter } from '../components/SidebarFooter.js';
 import type { TemplateOptions } from '../types.js';
 import { useRouteError, isRouteErrorResponse } from '@remix-run/react';
 type ManifestProject = Required<SiteManifest>['projects'][0];
@@ -102,7 +103,7 @@ function ArticlePageAndNavigationInternal({
       <PrimaryNavigation
         sidebarRef={toc}
         hide_toc={hide_toc}
-        footer={<MadeWithMyst />}
+        footer={<SidebarFooter content={projectParts?.primary_sidebar_footer?.mdast} />}
         projectSlug={projectSlug}
       />
       <TabStateProvider>

themes/book/template.yml

@@ -74,6 +74,9 @@ parts:
   - id: footer
     description: The site wide footer
     required: false
+  - id: primary_sidebar_footer
+    description: The primary sidebar footer, to replace Made with MyST
+    required: false
 build:
   install: npm install
   start: npm run start