Skip to content

feat: Add a <termshow-player> element for any HTML page - #449

Merged
rich-iannone merged 8 commits into
mainfrom
feat-termshow-web-component
Oct 27, 2026
Merged

rich-iannone merged 8 commits into
mainfrom
feat-termshow-web-component

Conversation

@rich-iannone

Copy link
Copy Markdown
Member

This PR adds a <termshow-player> element, so Termshow recordings can play on pages not built with Quarto, such as MkDocs, Sphinx, Docusaurus or plain HTML. It reuses the existing player code: its attributes match the shortcode options, src takes a render directory or a manifest URL, and a manifest can also be embedded inside the element. It also has a small script API modeled on <video> (play(), pause(), seek(), currentTime, duration, paused) and fires ready, play, pause and ended events.

A new great-docs termshow assets DIR command copies the player's script, stylesheet and fonts and prints the HTML to load them. The shortcode keeps working as before, and the PR also fixes an error the player threw when its script loaded in the page's <head>.

@github-actions

Copy link
Copy Markdown

📚 Preview this PR's docs locally

Fetch the just-built site and open it in your browser:

# this exact build
great-docs preview --run 40570219419

# or always the latest build for this PR
great-docs preview --pr 449
Auth & tips
  • Requires great-docs: pip install great-docs (or run via pipx/uvx).
  • Auth: run gh auth login then add --use-gh, or set GITHUB_TOKEN (needs Actions: read).
  • Jump to a page: add --path reference/index.html.
  • Latest vs exact: --pr <n> grabs the newest build; --run <id> pins this one.
  • Re-download: --refresh ignores the local cache.

@rich-iannone
rich-iannone merged commit 2ed7960 into main Oct 27, 2026
8 checks passed
@rich-iannone
rich-iannone deleted the feat-termshow-web-component branch October 27, 2026 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant