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.

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

Uploaded Source

Built Distribution

mkdocs_asciinema_player-0.8.2-py3-none-any.whl (89.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for mkdocs_asciinema_player-0.8.2.tar.gz
Algorithm Hash digest
SHA256 0e5cf6c43689f054bb412abb4ec3b23f29ec96641bdca6e233e2b7e7e778082c
MD5 fabde1aa92949cddd1c6dee81b72cee9
BLAKE2b-256 8621574049fdbfcd323d67cb29a19897af0300202087b87577c6851ad0a2f632

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_asciinema_player-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4d106358092e843c68b23a5029270fe1b3bc89ad88ce2250e88044c977264d04
MD5 202dd52a67d9c62a7b50867d604b2db8
BLAKE2b-256 3059627774cd58b595a66a232b5a72d4fd54b73ab0e8a53272cd398aa040c0aa

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