Termynal
A lightweight and modern animated terminal window. Built for mkdocs and zensical.
Installation
Usage
Use <!-- termynal --> before code block
<!-- termynal -->
```
$ python script.py
```
Mkdocs integration
Declare the plugin:
...
plugins:
- termynal
...
Optionally, pass options to the processor:
[...]
plugins:
- termynal:
prompt_literal_start:
- "$"
- ">"
[...]
If you do not want to copy termynal.css and termynal.js as static files,
you can embed them directly in generated HTML:
[...]
plugins:
- termynal:
include_assets: true
[...]
This config allows you to use another prompt:
<!-- termynal -->
```
> pip install termynal
---> 100%
Installed
```
Zensical integration
zensical does not support arbitrary MkDocs plugins yet, but it supports Python Markdown extensions.
Use termynal as a markdown extension and enable inline assets:
[project.markdown_extensions.termynal]
include_assets = true
title = "bash"
buttons = "macos"
prompt_literal_start = ["$"]
You can override default assets with your own files:
[project.markdown_extensions.termynal]
include_assets = true
assets_override_css = "docs/stylesheets/termynal.css"
assets_override_js = "docs/javascripts/termynal.js"
For Zensical-style asset management, keep include_assets = false and register
assets explicitly:
[project]
extra_css = ["stylesheets/termynal.css"]
extra_javascript = ["javascripts/termynal.js"]
[project.markdown_extensions.termynal]
include_assets = false
Credits
Thanks ines
Contribution
1 maintainer
Metadata
1 maintainer
Release files for termynal 0.14.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| termynal-0.14.0.tar.gz | 178.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| termynal-0.14.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 189.8 kB
Release files / termynal-0.14.0.tar.gz
| Download URL | termynal-0.14.0.tar.gz |
|---|---|
| Size | 178.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2918a1a6cf468497fbb3a72dc3726743988829eef1136d0c78a81df70ec869f6
|
|
BLAKE2b-256 checksum How to use checksums |
268cea13868e6008ed964837db011648e3e7766e0ecfa1b42d7b9a4cf0c228e2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / termynal-0.14.0-py3-none-any.whl
| Download URL | termynal-0.14.0-py3-none-any.whl |
|---|---|
| Size | 11.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b5147545e29256d35148251f5c2d3d23dec1d2fb0b4ba464ff330a7de8b56fc6
|
|
BLAKE2b-256 checksum How to use checksums |
c38fc089f7c9f9fc1da25e6271386e5df84e1f6e0b04d2f0b408939b51b2876f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
