great-docs termshow export

Export a recording as one self-contained animated SVG.

great-docs termshow export [OPTIONS] SOURCE

The SVG plays with CSS alone, so it works as an image in a GitHub or GitLab README. The companion .termshow.yml script’s cuts, speed changes, chapters, and annotations are applied unless --no-script is given.

With a light/dark theme pair, two files are written (NAME-light.svg and NAME-dark.svg), along with a snippet that picks one by the reader’s color scheme.

Full --help output

Usage: great-docs termshow export [OPTIONS] SOURCE

  Export a recording as one self-contained animated SVG.

  The SVG plays with CSS alone, so it works as an image in a GitHub or GitLab
  README. The companion .termshow.yml script's cuts, speed changes, chapters,
  and annotations are applied unless --no-script is given.

  With a light/dark theme pair, two files are written (NAME-light.svg and
  NAME-dark.svg), along with a <picture> snippet that picks one by the
  reader's color scheme.

  Examples:   great-docs termshow export demos/install.termshow   great-docs
  termshow export demos/install.termshow --svg -o install.svg

Options:
  --svg              Write an animated SVG (the default, and currently the
                     only format)
  -o, --output FILE  Output file (default: the recording's name with .svg)
  --script PATH      Path to .termshow.yml script
  --no-script        Ignore any companion .termshow.yml script
  --no-loop          Play once and stop on the last screen
  --end-pause FLOAT  Seconds to hold the last screen before looping  [default:
                     2.0]
  --chapter-cards    Show a title card at each chapter
  --no-annotations   Leave out the script's annotations
  --font-file FILE   Embed this .woff2/.woff/.ttf/.otf font for the terminal
                     text
  --help             Show this message and exit.

Arguments

SOURCE: PATH: Required.

Options

--svg: Write an animated SVG (the default, and currently the only format)
-o, --output: FILE: Output file (default: the recording’s name with .svg)
--script: PATH: Path to .termshow.yml script
--no-script: Ignore any companion .termshow.yml script
--no-loop: Play once and stop on the last screen
--end-pause: FLOAT = 2.0: Seconds to hold the last screen before looping
--chapter-cards: Show a title card at each chapter
--no-annotations: Leave out the script’s annotations
--font-file: FILE: Embed this .woff2/.woff/.ttf/.otf font for the terminal text

Examples

  great-docs termshow export demos/install.termshow
  great-docs termshow export demos/install.termshow --svg -o install.svg