termynal / termynal.py

Python markdown terminal. Built for mkdocs
https://termynal.github.io/termynal.py/
MIT License
95 stars 8 forks source link
markdown mkdocs python termynal

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](https://github.com/ines/termynal)

## Contribution

[Contribution guidelines for this project](CONTRIBUTING.md)