Book theme options to specify theme and disable theme toggle button

[gvarnavi]

Adds the following two options to the book-theme:

site:
  template: book-theme
  options:
    theme: 'dark'
    hide_theme_toggle: true

• theme can either be 'light' or 'dark' and forces the initial theme (as opposed to using local storage)
• hide_theme_toggle is a boolean and disables the top-right theme toggle

[changeset-bot]

⚠️ No Changeset found

Latest commit: 536dac3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[agoose77]

Hi @gvarnavi,

Thank you for opening this PR!

Theme selectors are an important part of accessibility (though there is nuance to that point). Is there a particular reason that you want to disable this preference for your users of the theme?

[gvarnavi]

Thanks for the prompt reply @agoose77 !

The real use case is that I started modifying the book-theme to achieve a stripped-down "presentation-like" look, similar to what I've been using with Observable Framework.
I was pleasantly surprised to find out I could get most of the way there with site options such as

  template: book-theme
  options:
    logo: ./figures/logo.svg
    logo_dark: ./figures/logo_dark.svg
    hide_outline: true
    hide_title_block: true
    hide_search: true

But wanted more customization to completely style/disable the header, hence the hide_theme_toggle option.

As for locking in the theme, we use a lot of interactive matplotlib figures for the Elemental Microscopy journal, which are challenging to have support both light/dark themes both when static (we should at the very least add a placeholder_dark attribute to the figure directives), but also when dynamic (due to matplotlib not providing transparent backgrounds, and the Jupyter kernel presumably not able to access the current theme/theme changes).

I appreciate the accessibility point, but that requires a level of sophistication I don't think is currently easy to support for interactive figures (in contrast e.g. to MyST tables, which look great in both).

Thanks again for looking into this!

[agoose77]

Thanks for the quick reply @gvarnavi. It took me a bit longer to circle round here than usual.

The question around removing accessibility from the user is tricky, and I don't have all the answers. I can see why it is useful for your use case! I'll bring this up at our developers meeting.

[gvarnavi]

I wanted to quickly follow-up on this. I just gave a conference talk using a slightly-modified book-theme found here: https://github.com/gvarnavi/custom-myst-book-theme.

It was very well received and I'd be happy to prototype this further if you think that would be useful to contribute a presentation-theme template, in which case we can close this PR. @rowanc1