mkdocs-asciinema-player

April 28, 2025 · View on GitHub

A Mkdocs Plugin to include asciinema player in your documentation.

Name	Description
98.css	98.css from jdan

Quick Setup

Install the plugin via pip :

pip install mkdocs-asciinema-player

In your mkdocs.yml, add asciinema-player to the plugins section :

plugins:
  - search
  - asciinema-player

In your MkDocs docs folder, add any asciinema .cast file and add this to any markdown page :

```asciinema-player
{
    "file": "assets/asciinema/bootstrap.cast"
}
```

For more information on the plugin, you can visit the the following website

You will find the complete documentation of the plugin, examples of use, installation and configuration instructions.