Metadata-Version: 2.1
Name: mkdocs-asciinema-player
Version: 0.4.0
Summary: A Mkdocs Plugin to include asciinema player in your documentation.
Project-URL: Homepage, https://github.com/pa-decarvalho/mkdocs-asciinema-player
Project-URL: Bug Reports, https://github.com/pa-decarvalho/mkdocs-asciinema-player/issues
Project-URL: Source, https://github.com/pa-decarvalho/mkdocs-asciinema-player
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Operating System :: POSIX
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Software Development :: Build Tools
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.5.3
Provides-Extra: dev
Requires-Dist: asciinema==2.4.0; extra == "dev"
Requires-Dist: commitizen==3.13.0; extra == "dev"
Provides-Extra: lint
Requires-Dist: bandit==1.7.5; extra == "lint"
Requires-Dist: djlint==1.34.0; extra == "lint"
Requires-Dist: flake8==6.0.0; extra == "lint"
Requires-Dist: mypy==1.7.1; extra == "lint"
Requires-Dist: pylint==3.0.2; extra == "lint"
Requires-Dist: yamllint==1.32.0; extra == "lint"
Provides-Extra: test
Requires-Dist: pytest==7.4.0; extra == "test"

# 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)

A Mkdocs Plugin to include asciinema player in your documentation.

## Setup

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
```

In your `.gitignore` file, add this part to ignore copied files :

```sh
# Auto generated assets
docs/assets/css
docs/assets/js
```

## Usage

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

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