Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

myst-fullscreen

Fullscreen Button Plugin

A MyST plugin that adds a {fullscreen} role to toggle browser fullscreen mode.

MyST Demo
Click here to go fullscreen: {fullscreen}`click`

Click here to go fullscreen:

You can also see this in the primary sidebar to the left (at the bottom), it’s added in myst.yml, e.g.:

myst.yml
version: 1
project:
  id: myst-fullscreen
  title: myst-fullscreen
  github: https://github.com/choldgraf/myst-fullscreen
  plugins:
    - ../src/index.mjs
    - https://raw.githubusercontent.com/jupyter-book/myst-plugins/main/plugins/demo/src/index.mjs
  parts:
    primary_sidebar_footer: |
      Click here! 👉 {fullscreen}`click`
  toc:
    - file: index.md

site:
  template: book-theme
  options:
    logo_text: myst-fullscreen