Skip to content

Added documentation for hideKeystroke option for the webplayer #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added documentation for hideKeystroke option for the webplayer #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7297ca1
Added documentation for hideKeystroke option for the webplayer
ikks Oct 10, 2024
bf6e2e3
Added Keyboard shortcut to hide keystrokes visualization
ikks Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/manual/player/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,22 @@ wherever you want to explain terminal contents in more detail.

Defaults to `false`.

### `hideKeystroke`

Type: boolean

Set this option to `true` to hide the keypresses.

Defaults to `false`.

!!! note

means the keys are shown if the video was [recorded with the
option --stdin](../cli/usage.md#asciinema-rec-filename), i.e.
`asciinema rec --stdin <filename>`.



### `terminalFontSize`

Type: string
Expand Down
2 changes: 2 additions & 0 deletions docs/manual/player/shortcuts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ focus:
* <kbd>f</kbd> - toggle fullscreen mode
* <kbd>←</kbd> / <kbd>→</kbd> - rewind / fast-forward by 5 seconds
* <kbd>Shift</kbd> + <kbd>←</kbd> / <kbd>→</kbd> - rewind / fast-forward by 10%
* <kbd>k</kbd> - toggle keystroke visualization
* <kbd>[</kbd> / <kbd>]</kbd> - jump to the previous / next [marker](markers.md)
* <kbd>0</kbd>, <kbd>1</kbd>, <kbd>2</kbd> ... <kbd>9</kbd> - jump to 0%, 10%, 20% ... 90%
* <kbd>.</kbd> - step through a recording, one frame at a time (when paused)
* <kbd>?</kbd> - toggle help popup

Go ahead and try them out in the player below:

Expand Down