great-docs termshow transcript

Write the text of a recording, or captions for it.

great-docs termshow transcript [OPTIONS] SOURCE

The transcript holds everything the recording shows, including lines that scroll away, as plain text without colors. The companion .termshow.yml script’s chapters split it into sections, its annotations become notes, and its prompt replacement is applied, unless --no-script is given. A full-screen program, like less or vim, keeps only its last screen.

With --vtt, the annotations are written as WebVTT captions; with --vtt-chapters, the chapters are written as a WebVTT chapters track. Both are on the playback timeline (after cuts and speed changes).

Great Docs builds write each recording’s transcript next to its player, for screen readers, search, and the page’s Markdown version.

Full --help output

Usage: great-docs termshow transcript [OPTIONS] SOURCE

  Write the text of a recording, or captions for it.

  The transcript holds everything the recording shows, including lines that
  scroll away, as plain text without colors. The companion .termshow.yml
  script's chapters split it into sections, its annotations become notes, and
  its prompt replacement is applied, unless --no-script is given. A full-
  screen program, like less or vim, keeps only its last screen.

  With --vtt, the annotations are written as WebVTT captions; with --vtt-
  chapters, the chapters are written as a WebVTT chapters track. Both are on
  the playback timeline (after cuts and speed changes).

  Great Docs builds write each recording's transcript next to its player, for
  screen readers, search, and the page's Markdown version.

  Examples:   great-docs termshow transcript demos/install.termshow   great-
  docs termshow transcript demos/install.termshow -o install.md   great-docs
  termshow transcript demos/install.termshow --vtt -o install.vtt

Options:
  --markdown         Write the recording's text as Markdown (the default)
  --vtt              Write the annotations as WebVTT captions
  --vtt-chapters     Write the chapters as a WebVTT track
  -o, --output FILE  Output file (default: print to the terminal)
  --script PATH      Path to .termshow.yml script
  --no-script        Ignore any companion .termshow.yml script
  --help             Show this message and exit.

Arguments

SOURCE: PATH: Required.

Options

--markdown: Write the recording’s text as Markdown (the default)
--vtt: Write the annotations as WebVTT captions
--vtt-chapters: Write the chapters as a WebVTT track
-o, --output: FILE: Output file (default: print to the terminal)
--script: PATH: Path to .termshow.yml script
--no-script: Ignore any companion .termshow.yml script

Examples

  great-docs termshow transcript demos/install.termshow
  great-docs termshow transcript demos/install.termshow -o install.md
  great-docs termshow transcript demos/install.termshow --vtt -o install.vtt