mkdocs-asciinema-player 0.15.0

A Mkdocs Plugin to include asciinema player in your documentation.

mkdocs-asciinema-player

A Mkdocs Plugin to include asciinema player in your documentation.

Related Projects

Name	Description
98.css	98.css from jdan

Quick Setup

Installation

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

Usage

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

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

More

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.

Contributing

See CONTRIBUTING.md file.