bczsalba / termage Goto Github PK
View Code? Open in Web Editor NEWGenerate SVGs from any Python code, even in your documentation.
Home Page: https://termage.bczsalba.com
License: MIT License
Generate SVGs from any Python code, even in your documentation.
Home Page: https://termage.bczsalba.com
License: MIT License
Describe the bug
When invoking termage
in a VTE3 based terminal emulator, e.g. with termage -h
, something that I suspect is terminal initialization codes are visible.
To Reproduce
terminator
or sakura
.termage
with termage -h
Expected behavior
Teminal initialization codes ought to be invisible for the casual user.
Screenshots
In the screenshot of a terminator
window just below the sprinkles can be clearly seen:
Platform info
I have seen it happen in VTE3 based terminal emulators:
But not in terminal emulators that are not based on VTE3:
PTG
Termage doesn't have a --version
option, but pip
has installed v0.2.0.
Describe the bug
When calling pip install mkdocs-termage-plugin
the installation fails, seemingly because of a ModuleNotFoundError
.
To Reproduce
Just run pip install mkdocs-termage-plugin
from a terminal prompt.
Expected behavior
I expected the package to be downloaded and installed.
Screenshots
Platform info
Browser: Not a browser, see screenshot of terminal
Is your feature request related to a problem? Please describe.
Could termage
be implented as a standalone app?
Describe the solution you'd like
It would be weet to be able to generate an SVG (or more generally, an image) from a given code file. E.g.:
$ termage --help
Usage: termage [INPUT [OUTPUT]]
$ termage hello-world.py hello-world.svg
Describe alternatives you've considered
I usually go to https://carbon.now.sh/ to generate images from my code, so that I can post it on e.g. social media or on a blog. It would be sweeter to be able to do it from the commandline.
Describe the bug
When generating from a clear tree (e.g. docs/assets
is empty), the first run will have mkdocs
complain about links to non-detected files:
To Reproduce
Steps to reproduce the behavior:
rm -rf docs/assets/*
mkdocs serve
If the development server is killed and restarted, the problem goes away.
Expected behavior
The files should be detected on first run.
Platform info
Browser: All
PTG:
PyTermGUI version 6.2.1
System details:
Python version: 3.9.12
$TERM: xterm-kitty
$COLORTERM: truecolor
Color support: ColorSystem.TRUE
OS Platform: macOS-12.3.1-arm64-arm-64bit
Is your feature request related to a problem? Please describe.
It's a bit annoying having to set every configuration value on a per-codeblock basis. Also, it is currently not possible to change the
output directory or naming scheme.
Describe the solution you'd like
Introduce mkdocs
config options:
plugins:
- termage:
output_dir: "docs/termage"
output_name_template: "screenshot_{index}.svg"
background: "#dddddd"
foreground: "#212121"
Describe alternatives you've considered
Manual configuration, but it's very restrictive.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.