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.
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.
Contributing
See CONTRIBUTING.md file.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_asciinema_player-1.2.0.tar.gz.
File metadata
- Download URL: mkdocs_asciinema_player-1.2.0.tar.gz
- Upload date:
- Size: 78.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
affea54b28221ff39c5de0ee2a204143bbf37aa18195492290a58b1cead3fd17
|
|
| MD5 |
297a50f02c10fbd36091b53da4000e29
|
|
| BLAKE2b-256 |
0da9d3fd2fc5720cf1f8bf84f176e1e10fe59d2f700eeeb761902704575a730b
|
File details
Details for the file mkdocs_asciinema_player-1.2.0-py3-none-any.whl.
File metadata
- Download URL: mkdocs_asciinema_player-1.2.0-py3-none-any.whl
- Upload date:
- Size: 81.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5f73dfc0d1f4621451e03d690cba281cee4612925266c82f5a6152b249b56277
|
|
| MD5 |
f915a888277d433f41c8a4006a56cf50
|
|
| BLAKE2b-256 |
4af8ef78a88cd0bfb7076f129452dcf585d3f3aa92ff82f30a239ff9b18fd3b5
|
