Examples¶
Short recordings of narratty's features, each with the spec that made it. The specs
are in examples/; build
one with narratty build <spec>.
| Example | Shows | Select with |
|---|---|---|
| Voices and engines | Kokoro and Piper voices, English and German | tts.provider, tts.voice |
| Pronunciation | Terms spelled as in the code, spoken correctly | tts.lexicon |
| Terminal look | Theme, font, prompt, typing speed | terminal |
| Editor layout | Explorer, preview and shell in one tmux window | terminal.layout: editor |
| Subtitles and drafts | Burned-in subtitles; a fast preview without TTS | subtitles, --draft |
| Asciicast player | Selectable terminal text with a narration track | --format cast |
| Web pages | The project's GitHub page, captured and scrolled | browser |
| Overlays | Chapter titles, file names, notes over the video | overlay, overlay_styles |
| Dev container | A build recorded in the project's dev container | environment.compose |
| End card | "Created with narratty" card with logo, link and QR code | end_card, --no-end-card |
All recordings except the end card example are built with --no-end-card.
examples/render-docs.sh rebuilds them.