https://github.com/bczsalba/termage

Generate SVGs from any Python code, even in your documentation.
https://github.com/bczsalba/termage

documentation mkdocs mkdocs-material mkdocs-plugin pytermgui svg-images

Last synced: 9 days ago
JSON representation

Generate SVGs from any Python code, even in your documentation.

• Host: GitHub
• URL: https://github.com/bczsalba/termage
• Owner: bczsalba
• License: mit
• Created: 2022-05-25T14:17:44.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-11-15T12:36:14.000Z (over 2 years ago)
• Last Synced: 2025-03-26T15:21:11.576Z (27 days ago)
• Topics: documentation, mkdocs, mkdocs-material, mkdocs-plugin, pytermgui, svg-images
• Language: Python
• Homepage: https://termage.bczsalba.com
• Size: 777 KB
• Stars: 25
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Termage

See the [docs](https://termage.bczsalba.com) for some live examples.

`Termage` allows you to generate up-to-date, reproducible and _real_ screenshots of Python output while building your documentation. It uses [PyTermGUI](https://github.com/bczsalba/pytermgui) to create the SVGs, and pre-processes your markdown file into a `codefences` format.

![Code](https://raw.githubusercontent.com/bczsalba/mkdocs-termage-plugin/master/assets/code.png)

![Output](https://raw.githubusercontent.com/bczsalba/mkdocs-termage-plugin/master/assets/output.png)

## Installation

`Termage` is best installed using `pip`:

```

$ pip install mkdocs-termage-plugin

```

This installs the plugin, as well as PyTermGUI as a dependency. By this point you probably _should_ already have mkdocs installed.

## Setup

To use the plugin, you should first add it to your `mkdocs.yml` plugin list:

```yaml

plugins:

    - termage

```