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.1.tar.gz (87.4 kB view details)

Uploaded Source

Built Distribution

mkdocs_asciinema_player-0.10.1-py3-none-any.whl (87.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for mkdocs_asciinema_player-0.10.1.tar.gz
Algorithm Hash digest
SHA256 270f1d7f2521e82ab9105a1dff8fbd24bca7290987fce8ba0eaa4f91001af20d
MD5 298c769c6db38ba865cdd95df1b37938
BLAKE2b-256 24f861d0d8b5ae9a0d24c74d2820b5b57b63fc9ce3b35a0c298e3f812d51f9f2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_asciinema_player-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 94f61cc99a3b92815754d752f9c5bf00febb7e2ab451efa9aa4fe842566d8540
MD5 279dc330abd4e70bf5a440c3d595337c
BLAKE2b-256 d817f0fc56e5ac72a01bd1a1f3ee4c3696bbb150160d047af2aac08cee74ca14

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