Skip to content

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

License

Notifications You must be signed in to change notification settings

bczsalba/Termage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Termage

See the docs 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 to create the SVGs, and pre-processes your markdown file into a codefences format.

Code Output

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:

plugins:
    - termage

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages