User Interface Components

This page documents site-level UI components that appear on every page. use the same configuration pattern through site.parts or project.parts in myst.yml.

Configuration via parts¶

Many of the UI areas below allow users to insert custom content or interface elements using parts. These are documented below, and in each case they use the same configuration pattern through site.parts or project.parts in myst.yml.

Navigation bar¶

Site logo¶

Control the logo with the following configuration:

site:
  options:
    logo: path-to-logo.png
    logo_dark: path-to-dark-theme-logo.pnd
    logo_text: text to display just after the logo
    logo_url: clicking the logo will take users here
    logo_alt: alternative text for the site logo

Banner¶

Display an announcement bar at the top of your site.

Configuration¶

Create a markdown file with your banner content and add it to myst.yml:

site:
  parts:
    banner: _site/banner.md

or directly as text:

site:
  parts:
    banner: My banner [content](https://mystmd.org)!

Behavior¶

• Appears at the top of every page, above the navigation

• Users can dismiss it by clicking the X button

• Dismissal persists in the browser

• Will expand vertically if extra content is in it

• If you change the banner content, it will reappear for all users

Footer¶

Display custom content at the bottom of every page.

Configuration¶

Create a markdown file with your footer content and add it to myst.yml:

site:
  parts:
    footer: _site/footer.md

Behavior¶

• 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:

site:
  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

Hiding Elements¶

Control the visibility of various page elements. All options can be set site-wide or per-page.

Hide Authors¶

Hide the author and affiliations list from the frontmatter block.

site:
  options:
    hide_authors: true

Hide Table of Contents¶

Hide the left sidebar table of contents.

site:
  options:
    hide_toc: true

Hide Outline¶

Hide the right sidebar document outline.

site:
  options:
    hide_outline: true

Hide Title Block¶

Hide the entire frontmatter block (title, authors, date, etc.).

site:
  options:
    hide_title_block: true

Hide Footer Links¶

Hide the previous/next navigation links at the bottom of each page.

site:
  options:
    hide_footer_links: true

Hide Search¶

Disable the search functionality.

site:
  options:
    hide_search: true

Page-level Overrides¶

Any of these options can be set on individual pages to override site-wide settings:

---
site:
  hide_authors: true
  hide_outline: true
---