Skip to content

[🛠️] Feature Request: Add new output mode for image (SVG), rename README_PATH to OUTPUT_PATH #56

@gltched-usr

Description

@gltched-usr

Is your feature request related to a problem?

Currently, the output is limited to updating the README directly in the user's main repository. This generates a lot of commit noise and introduces merge conflicts if the README changes for other reasons. Using an image output mode (preferably SVG for selectable/copiable text) allows you to generate and update outputs in a separate "automation" repo, keeping the main repo's commit history clean and reducing the risk of merge conflicts.

Who benefits?

Anyone who uses the output automation feature, especially those who want to avoid frequent README updates and merge conflicts. This will also benefit users who wish to keep their main repository clean by using a separate automation repo for generated outputs.

How important is this feature?

Nice to have

Describe the solution you'd like

Add a new output mode that generates and outputs an image (such as SVG, preferably SVG because you can still make the text selectable and copiable). Instead of directly modifying the README, the tool would output an image file (e.g., SVG) and embed the image in the README. Additionally, rename the configuration variable from README_PATH to OUTPUT_PATH to reflect that output can now be an image. This reduces commit noise and avoids README merge conflicts, and enables usage with a separate automation repository.

Describe alternatives you've considered

Alternatives considered include continuing to update the README directly, but that leads to clutter and merge conflicts. Another option might be to write outputs to a different markdown file, but embedding an image is more flexible and visually appealing.

Additional context

By outputting an image and embedding it, the workflow becomes cleaner, and the main documentation stays readable and less prone to accidental merge issues. This is particularly useful for projects where output is generated frequently, and even more so if you want to use a separate automation repo for generation.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requesthelp wantedExtra attention is needed

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions