A Mkdocs Plugin to include asciinema player in your documentation.
Project description
mkdocs-asciinema-player
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs-asciinema-player-0.8.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 602701efddce74ee295e5fe02acc3316c44ce6d483473dc950cb205023e76ac0 |
|
MD5 | 0cad2acf9209c67958b6d27e7ba1c5e2 |
|
BLAKE2b-256 | c55946917abdd0a0282d77224aed4f995bd3f9f5a7bad0eda77a8d9a6bc7b873 |
Close
Hashes for mkdocs_asciinema_player-0.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ef461d74290ef5e9857af774f85420ae2020b6e22ab072e279f68d183ca5b35 |
|
MD5 | 6e53eef52cc7cbdc9ca134fa280824c1 |
|
BLAKE2b-256 | 2e99cbcf44f5e4ed022636c6ca79f606988587db74636cc64a115fb2085b2e9b |