https://github.com/termynal/termynal.py

Python markdown terminal. Built for mkdocs
https://github.com/termynal/termynal.py

markdown mkdocs python termynal

Last synced: about 2 months ago
JSON representation

Python markdown terminal. Built for mkdocs

• Host: GitHub
• URL: https://github.com/termynal/termynal.py
• Owner: termynal
• License: mit
• Created: 2020-11-12T19:59:40.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-01T20:31:46.000Z (4 months ago)
• Last Synced: 2024-07-19T10:58:38.703Z (2 months ago)
• Topics: markdown, mkdocs, python, termynal
• Language: Python
• Homepage: https://termynal.github.io/termynal.py/
• Size: 2.29 MB
• Stars: 85
• Watchers: 1
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Termynal

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/termynal/termynal.py/check.yml)

[![PyPI](https://img.shields.io/pypi/v/termynal)](https://pypi.org/project/termynal/)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/termynal)](https://www.python.org/downloads/)

[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://termynal.github.io/termynal.py/)

![GitHub](https://img.shields.io/github/license/termynal/termynal.py)

![PyPI - Downloads](https://img.shields.io/pypi/dm/termynal)

![GitHub last commit](https://img.shields.io/github/last-commit/termynal/termynal.py)

A lightweight and modern animated terminal window.

Built for [mkdocs](https://www.mkdocs.org/).

## Installation

![termynal](termynal.gif)

[Examples](https://termynal.github.io/termynal.py/)

## Usage

Use `` before code block

````

```

$ python script.py

```

````

### Mkdocs integration

Declare the plugin:

```yaml

...

plugins:

  - termynal

...

```

Optionally, pass options to the processor:

```yaml

[...]

plugins:

  - termynal:

      prompt_literal_start:

        - "$"

        - ">"

[...]

```

This config allows you to use another prompt:

````markdown

```

> pip install termynal

---> 100%

Installed

```

````

## Credits

Thanks [ines](https://github.com/ines/termynal)

## Contribution

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