Termynal

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

Installation

$ pip install termynal
---> 100%
Installed

Example

Usage

Use <!-- termynal --> before code block

<!-- termynal -->

```
// code
```

or console in code block

```console
// code
```

progress, prompt ---> 100%

```console
$ show progress
---> 100%
Done!
```

command, start with $

```console
$ command
```

comment, start with #

```console
# comment
```

Mkdocs integration

Declare the plugin:

...
plugins:
  - termynal
...

Optionally, pass options to the processor:

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