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

Mkdocs Plugin to include asciinema player in your documentation.
https://github.com/pa-decarvalho/mkdocs-asciinema-player

documentation markdown mkdocs python

Last synced: 3 months ago
JSON representation

Mkdocs Plugin to include asciinema player in your documentation.

• Host: GitHub
• URL: https://github.com/pa-decarvalho/mkdocs-asciinema-player
• Owner: pa-decarvalho
• License: mit
• Created: 2023-10-29T12:48:03.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-12T13:33:27.000Z (5 months ago)
• Last Synced: 2024-09-28T19:05:10.724Z (3 months ago)
• Topics: documentation, markdown, mkdocs, python
• Language: CSS
• Homepage: https://pa-decarvalho.github.io/mkdocs-asciinema-player/
• Size: 2.89 MB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mkdocs-asciinema-player

[![documentation](https://img.shields.io/badge/docs-mkdocs--asciinema--player-blue.svg?style=flat)](https://pa-decarvalho.github.io/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/)

[![downloads](https://img.shields.io/pypi/dm/mkdocs-asciinema-player.svg)](https://pypi.org/project/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.