Skip to content

Pronunciation

Narration keeps the real spelling of terms (k8s, kubectx), so it stays correct and searchable. The lexicon tells the engine how to say them. See Pronunciation.

With the lexicon:

Without it ("k eight z", "cube ect x"):

tts:
  lexicon:
    k8s: kubernetes
    kubectx: cube C T X
    ttyd: T T Y D
terminal: {width: 960, height: 540, font_size: 20}
scenes:
  - id: lexicon
    narration: >-
      Deploy to k8s with kubectl, switch clusters with kubectx, and share the
      terminal with ttyd.
    actions:
      - run: "grep -m1 -A4 tts: lexicon.narratty.yaml"

kubectl needs no entry: it is in the built-in lexicon. Put entries shared by several specs in narratty.lexicon.toml in the repository or ~/.config/narratty/lexicon.toml.

narratty lexicon check examples/lexicon/lexicon.narratty.yaml   # words that may need an entry
narratty lexicon show examples/lexicon/lexicon.narratty.yaml    # merged entries and their source