Skip to content

termynal/termynal.py

Repository files navigation

Termynal

GitHub Workflow Status PyPI PyPI - Python Version Docs GitHub PyPI - Downloads GitHub last commit

A lightweight and modern animated terminal window. Built for mkdocs.

Installation

termynal

Examples

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:
        - "$"
        - ">"
[...]

This config allows you to use another prompt:

<!-- termynal -->

```
> pip install termynal
---> 100%
Installed
```

Credits

Thanks ines

Contribution

Contribution guidelines for this project