mkdocs-asciinema-player


Namemkdocs-asciinema-player JSON
Version 0.16.0 PyPI version JSON
download
home_pagehttps://github.com/pa-decarvalho/mkdocs-asciinema-player
SummaryA Mkdocs Plugin to include asciinema player in your documentation.
upload_time2025-02-12 10:32:51
maintainerPhilippe-André De Carvalho
docs_urlNone
authorPhilippe-André De Carvalho
requires_python<4.0,>=3.9
licenseMIT
keywords mkdocs documentation asciinema asciinema-player
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 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.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/pa-decarvalho/mkdocs-asciinema-player",
    "name": "mkdocs-asciinema-player",
    "maintainer": "Philippe-Andr\u00e9 De Carvalho",
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": "philippe.andre.decarvalho@gmail.com",
    "keywords": "mkdocs, documentation, asciinema, asciinema-player",
    "author": "Philippe-Andr\u00e9 De Carvalho",
    "author_email": "philippe.andre.decarvalho@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/88/1e/02ffe62a3c463973db22dbef1c04c8d5e409f4ea5887d158c6aa81770bec/mkdocs_asciinema_player-0.16.0.tar.gz",
    "platform": null,
    "description": "# mkdocs-asciinema-player\n\n[![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)\n[![test](https://github.com/pa-decarvalho/mkdocs-asciinema-player/workflows/test/badge.svg)](https://github.com/pa-decarvalho/mkdocs-asciinema-player/actions)\n[![pypi](https://img.shields.io/pypi/v/mkdocs-asciinema-player.svg)](https://pypi.org/project/mkdocs-asciinema-player/)\n[![pyversions](https://img.shields.io/pypi/pyversions/mkdocs-asciinema-player.svg)](https://pypi.python.org/pypi/mkdocs-asciinema-player)\n[![downloads](https://img.shields.io/pypi/dm/mkdocs-asciinema-player.svg)](https://pypi.org/project/mkdocs-asciinema-player/)\n[![license](https://img.shields.io/pypi/l/mkdocs-asciinema-player.svg)](https://pypi.python.org/pypi/mkdocs-asciinema-player)\n\nA Mkdocs Plugin to include asciinema player in your documentation.\n\n## Related Projects\n\n| Name                                                                                            | Description                                                            |\n|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|\n| [98.css](https://github.com/jdan/98.css)                                                        | 98.css from [jdan](https://github.com/jdan)                            |\n\n## Quick Setup\n\n### Installation\n\nInstall the plugin via pip :\n\n```sh\npip install mkdocs-asciinema-player\n```\n\n### Configure\n\nIn your `mkdocs.yml`, add `asciinema-player` to the `plugins` section :\n\n```yaml\nplugins:\n  - search\n  - asciinema-player\n```\n\n### Usage\n\nIn your MkDocs docs folder, add any [asciinema](https://asciinema.org/) `.cast` file and add this to any markdown page :\n\n````markdown\n```asciinema-player\n{\n    \"file\": \"assets/asciinema/bootstrap.cast\"\n}\n```\n````\n\n### More\n\nFor more information on the plugin, you can visit the the following [website](https://pa-decarvalho.github.io/mkdocs-asciinema-player/)\n\nYou will find the complete documentation of the plugin, examples of use, installation and configuration instructions.\n\n## Contributing\n\nSee [CONTRIBUTING.md](https://github.com/pa-decarvalho/mkdocs-asciinema-player/blob/main/CONTRIBUTING.md) file.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Mkdocs Plugin to include asciinema player in your documentation.",
    "version": "0.16.0",
    "project_urls": {
        "Documentation": "https://pa-decarvalho.github.io/mkdocs-asciinema-player/",
        "Homepage": "https://github.com/pa-decarvalho/mkdocs-asciinema-player",
        "Issues": "https://github.com/pa-decarvalho/mkdocs-asciinema-player/issues",
        "Repository": "https://github.com/pa-decarvalho/mkdocs-asciinema-player"
    },
    "split_keywords": [
        "mkdocs",
        " documentation",
        " asciinema",
        " asciinema-player"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cb3d9368776e95d42aff43acca746ca8e37f7abe2e2747c934dfe5cc55f23eab",
                "md5": "c76c120c37657b463b15276e17c23ce1",
                "sha256": "09a87fa1b1390b25bf38b8b8528f93f1cfd4ae181598231300a58e4665196b11"
            },
            "downloads": -1,
            "filename": "mkdocs_asciinema_player-0.16.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c76c120c37657b463b15276e17c23ce1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 92556,
            "upload_time": "2025-02-12T10:32:47",
            "upload_time_iso_8601": "2025-02-12T10:32:47.880716Z",
            "url": "https://files.pythonhosted.org/packages/cb/3d/9368776e95d42aff43acca746ca8e37f7abe2e2747c934dfe5cc55f23eab/mkdocs_asciinema_player-0.16.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "881e02ffe62a3c463973db22dbef1c04c8d5e409f4ea5887d158c6aa81770bec",
                "md5": "9a3bea674e57a67555de4adab88d4cde",
                "sha256": "4c30fca7351decdb69eff5176d58097cf593f3e8a886e992899c9f2910ce5450"
            },
            "downloads": -1,
            "filename": "mkdocs_asciinema_player-0.16.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9a3bea674e57a67555de4adab88d4cde",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 89930,
            "upload_time": "2025-02-12T10:32:51",
            "upload_time_iso_8601": "2025-02-12T10:32:51.577367Z",
            "url": "https://files.pythonhosted.org/packages/88/1e/02ffe62a3c463973db22dbef1c04c8d5e409f4ea5887d158c6aa81770bec/mkdocs_asciinema_player-0.16.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-12 10:32:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pa-decarvalho",
    "github_project": "mkdocs-asciinema-player",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-asciinema-player"
}
Philippe-André De Carvalho
Elapsed time: 0.66493s