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

Uploaded Source

Built Distribution

mkdocs_asciinema_player-0.9.0-py3-none-any.whl (81.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for mkdocs_asciinema_player-0.9.0.tar.gz
Algorithm Hash digest
SHA256 2dfb6efe4a6715ef363f00a7fc83f211d109f5382cf0a484fe17c3811528d70b
MD5 065a1ea2fc40c32dfd301d0c60aae161
BLAKE2b-256 3e000c8bbe1ffb4e8686af4974ad7f3fc89ec98db059ded01a9a1dbaabc0488b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_asciinema_player-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b55885388199e4038f4886274a2d2dd2b864d036b9ec2c7de726ddbcb84e61e
MD5 2c2248ac1cb16c05fb69e8748514143f
BLAKE2b-256 22fd2b096cc77dd335dc649a592366034054a859155f222ff498b15677a42d3e

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