Skip to main content

A Mkdocs Plugin to include asciinema player in your documentation.

Project description

mkdocs-asciinema-player

documentation test pypi downloads

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_asciinema_player-0.10.0.tar.gz (87.3 kB view details)

Uploaded Source

Built Distribution

mkdocs_asciinema_player-0.10.0-py3-none-any.whl (87.8 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_asciinema_player-0.10.0.tar.gz.

File metadata

File hashes

Hashes for mkdocs_asciinema_player-0.10.0.tar.gz
Algorithm Hash digest
SHA256 6d323f3108227cd7c0da3a1b685581a5a72d34e91e451457700f63f2097f55bb
MD5 319998c97873e58906558f883ba3cd51
BLAKE2b-256 6aa588d18721e7bfb0da436144662d542c7addf8394b1098acf4126890960e5c

See more details on using hashes here.

File details

Details for the file mkdocs_asciinema_player-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_asciinema_player-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6256b35cba1a66c187197d153aa436e52a7352aa5f5c644cda6a0f382e1e4bb9
MD5 e98d33bfef473c5a37aa0ceb6e6a3abd
BLAKE2b-256 0f2dd0ecddbb8666be3e74d438a40a41b579eda0f67337229608293d09c6ebfc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page