pa-decarvalho / mkdocs-asciinema-player

Mkdocs Plugin to include asciinema player in your documentation.

https://pa-decarvalho.github.io/mkdocs-asciinema-player/

MIT License

7 stars 1 forks source link

documentation markdown mkdocs python

readme

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](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.