| Name | mkdocs-asciinema-player JSON |
| Version |
0.8.1
JSON |
| download |
| home_page | None |
| Summary | A Mkdocs Plugin to include asciinema player in your documentation. |
| upload_time | 2024-03-28 17:54:56 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2023 Philippe-André De Carvalho Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
mkdocs
documentation
asciinema
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mkdocs-asciinema-player
[](https://pa-decarvalho.github.io/mkdocs-asciinema-player/)
[](https://github.com/pa-decarvalho/mkdocs-asciinema-player/actions)
[](https://pypi.org/project/mkdocs-asciinema-player/)
[](https://pypi.org/project/mkdocs-asciinema-player/)
A Mkdocs Plugin to include asciinema player in your documentation.
## 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-asciinema-player",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "mkdocs, documentation, asciinema",
"author": null,
"author_email": "Philippe-Andr\u00e9 De Carvalho <philippe.andre.decarvalho@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c5/59/46917abdd0a0282d77224aed4f995bd3f9f5a7bad0eda77a8d9a6bc7b873/mkdocs-asciinema-player-0.8.1.tar.gz",
"platform": null,
"description": "# mkdocs-asciinema-player\n\n[](https://pa-decarvalho.github.io/mkdocs-asciinema-player/)\n[](https://github.com/pa-decarvalho/mkdocs-asciinema-player/actions)\n[](https://pypi.org/project/mkdocs-asciinema-player/)\n[](https://pypi.org/project/mkdocs-asciinema-player/)\n\nA Mkdocs Plugin to include asciinema player in your documentation.\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",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Philippe-Andr\u00e9 De Carvalho Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A Mkdocs Plugin to include asciinema player in your documentation.",
"version": "0.8.1",
"project_urls": {
"Documentation": "https://pa-decarvalho.github.io/mkdocs-asciinema-player/",
"Issues": "https://github.com/pa-decarvalho/mkdocs-asciinema-player/issues",
"Source": "https://github.com/pa-decarvalho/mkdocs-asciinema-player"
},
"split_keywords": [
"mkdocs",
" documentation",
" asciinema"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e99cbcf44f5e4ed022636c6ca79f606988587db74636cc64a115fb2085b2e9b",
"md5": "6e53eef52cc7cbdc9ca134fa280824c1",
"sha256": "7ef461d74290ef5e9857af774f85420ae2020b6e22ab072e279f68d183ca5b35"
},
"downloads": -1,
"filename": "mkdocs_asciinema_player-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e53eef52cc7cbdc9ca134fa280824c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 79783,
"upload_time": "2024-03-28T17:54:53",
"upload_time_iso_8601": "2024-03-28T17:54:53.947576Z",
"url": "https://files.pythonhosted.org/packages/2e/99/cbcf44f5e4ed022636c6ca79f606988587db74636cc64a115fb2085b2e9b/mkdocs_asciinema_player-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c55946917abdd0a0282d77224aed4f995bd3f9f5a7bad0eda77a8d9a6bc7b873",
"md5": "0cad2acf9209c67958b6d27e7ba1c5e2",
"sha256": "602701efddce74ee295e5fe02acc3316c44ce6d483473dc950cb205023e76ac0"
},
"downloads": -1,
"filename": "mkdocs-asciinema-player-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "0cad2acf9209c67958b6d27e7ba1c5e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 80078,
"upload_time": "2024-03-28T17:54:56",
"upload_time_iso_8601": "2024-03-28T17:54:56.113101Z",
"url": "https://files.pythonhosted.org/packages/c5/59/46917abdd0a0282d77224aed4f995bd3f9f5a7bad0eda77a8d9a6bc7b873/mkdocs-asciinema-player-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-28 17:54:56",
"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"
}
