Metadata-Version: 2.1
Name: mkdocs-asciinema-player
Version: 0.15.0
Summary: A Mkdocs Plugin to include asciinema player in your documentation.
Home-page: https://github.com/pa-decarvalho/mkdocs-asciinema-player
License: MIT
Keywords: mkdocs,documentation,asciinema,asciinema-player
Author: Philippe-André De Carvalho
Author-email: philippe.andre.decarvalho@gmail.com
Maintainer: Philippe-André De Carvalho
Maintainer-email: philippe.andre.decarvalho@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Utilities
Requires-Dist: mkdocs (>=1.6.1,<2.0.0)
Project-URL: Documentation, https://pa-decarvalho.github.io/mkdocs-asciinema-player/
Project-URL: Issues, https://github.com/pa-decarvalho/mkdocs-asciinema-player/issues
Project-URL: Repository, https://github.com/pa-decarvalho/mkdocs-asciinema-player
Description-Content-Type: text/markdown

# mkdocs-asciinema-player

[![gitpod-ready-to-code](https://img.shields.io/badge/gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/pa-decarvalho/mkdocs-asciinema-player)
[![test](https://github.com/pa-decarvalho/mkdocs-asciinema-player/workflows/test/badge.svg)](https://github.com/pa-decarvalho/mkdocs-asciinema-player/actions)
[![pypi](https://img.shields.io/pypi/v/mkdocs-asciinema-player.svg)](https://pypi.org/project/mkdocs-asciinema-player/)
[![pyversions](https://img.shields.io/pypi/pyversions/mkdocs-asciinema-player.svg)](https://pypi.python.org/pypi/mkdocs-asciinema-player)
[![downloads](https://img.shields.io/pypi/dm/mkdocs-asciinema-player.svg)](https://pypi.org/project/mkdocs-asciinema-player/)
[![license](https://img.shields.io/pypi/l/mkdocs-asciinema-player.svg)](https://pypi.python.org/pypi/mkdocs-asciinema-player)

A Mkdocs Plugin to include asciinema player in your documentation.

## Related Projects

| Name                                                                                            | Description                                                            |
|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| [98.css](https://github.com/jdan/98.css)                                                        | 98.css from [jdan](https://github.com/jdan)                            |

## Quick Setup

### Installation

Install the plugin via pip :

```sh
pip install mkdocs-asciinema-player
```

### Configure

In your `mkdocs.yml`, add `asciinema-player` to the `plugins` section :

```yaml
plugins:
  - search
  - asciinema-player
```

### Usage

In your MkDocs docs folder, add any [asciinema](https://asciinema.org/) `.cast` file and add this to any markdown page :

````markdown
```asciinema-player
{
    "file": "assets/asciinema/bootstrap.cast"
}
```
````

### More

For more information on the plugin, you can visit the the following [website](https://pa-decarvalho.github.io/mkdocs-asciinema-player/)

You will find the complete documentation of the plugin, examples of use, installation and configuration instructions.

## Contributing

See [CONTRIBUTING.md](https://github.com/pa-decarvalho/mkdocs-asciinema-player/blob/main/CONTRIBUTING.md) file.

