Setup

Configuration

In your mkdocs.yml file, in the plugins section, you can use variables (Using plugins):

plugins:
  - search
  - asciinema-player:
      myvar: "example"

Below is a table of available variables:

Parameter	Value	Description
loglevel	"INFO"	Log level of the plugin ("DEBUG", "INFO", "WARNING", "ERROR", "FATAL").

To use individual configurations, create a JSON object like the example below:

{
    "file": "assets/asciinema/bootstrap.cast",
    "cols": 80,
    "auto_play": "true"
}

Below is a table of available configuration parameters:

Parameter	Value	Description
file	-	Path to the cast file.
title	"Terminal"	Title of the terminal.
mkap_theme	"night"	Theme of the terminal.
cols	80	Number of columns in the terminal.
rows	24	Number of rows in the terminal.
auto_play	false	Automatic playback upon load.
preload	false	Preload the cast file on load.
loop	false	Enable looped playback.
start_at	0	Start playback at a specific time.
speed	1	Playback speed multiplier.
theme	"asciinema"	Terminal theme for rendering.
fit	"width"	Terminal fit mode.
controls	"auto"	Display controls automatically.
pause_on_markers	false	Pause playback on markers.
terminal_font_size	"small"	Font size of the terminal.
terminal_font_family	"Consolas"	Font family of the terminal.
terminal_line_height	"1.33333333"	Line height of the terminal.

For more detailed information and additional options, refer to the official documentation.