Autocue speaker notes using Markdown

So I seem to have written a markdown-teleprompter-slideshow thing to scratch a personal itch.

This is for 'speaker notes' type scripts rather than verbatim scrolling autocue. Gojko Adzic has a lovely browser tool for that.

• H2 headings (##) separate slides
• Active bullet highlighted, the rest dim
  • Sub-bullets highlighted a different colour
• Keeps current bullet in centre of viewport ('typewriter mode') so you aren't looking up and down the screen
• Mirrors the text if you want (--mirror or press m)
• Uses Marp, so arrow keys, home/end, clicker all do what you would expect
• Live update: edit the markdown, view hot-reloads
• Theme-able, everything except scroll-centring is CSS

Auto-advance (Pecha Kucha mode)

Pass --auto-advance (or -a) to advance slides automatically after 20 seconds, or --auto-advance=N for a custom duration. A countdown timer appears in the corner so you always know how long you have left.

Usage

Put the following frontmatter in your Markdown file:

---
marp: true
---

Then run marp-cue from the directory like so:

% npx marp-cue [--mirror] your-notes.md # or npx marp-cue .

This will open a stripped-down browser window ('preview mode') for your file, or for every Markdown file in the directory that has marp: true. You can place this window in your teleprompter screen and the current line will stay vertically aligned in the middle of the viewport.

You can flip the view using the 'm' key or passing --mirror on the command line, to display correctly in a teleprompter if you don't already have a mirrored display.

Marp watches the file(s), so as soon as you save any changes, they show instantly without a refresh.

You can just generate the HTML file to run elsewhere by passing --preview false, which disables preview mode.