mkdocs-asciinema-player 0.4.0

A Mkdocs Plugin to include asciinema player in your documentation.

mkdocs-asciinema-player

A Mkdocs Plugin to include asciinema player in your documentation.

Setup

Install the plugin via pip :

pip install mkdocs-asciinema-player

Configure

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

plugins:
  - search
  - asciinema-player

In your .gitignore file, add this part to ignore copied files :

# Auto generated assets
docs/assets/css
docs/assets/js

Usage

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

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