microsoft / microsoft/terminal
Terminal cannot use SVG files in backgroundImage, icon (xaml limitation?)
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 105k
- Forks
- 9.6k
- Avg merge
- 3d 17h
- Merged PRs (30d)
- 29
Description
Over at UsingJsonSettings.md, in the section about adding a background image it directs me to download the .SVG image in Step 1
Step 4 then says to use the .JPG: ( "backgroundImage": "ms-appdata:///Roaming/openlogo.jpg", ) but this doesn't display the image in the Terminal.
Changing Step 4 to use the .SVG also doesn't display the image
Changing the file to be an actual .JPG (downloaded from the Debian logo page ) causes the image to appear.
The docs definitely need to be tweaked :)
(I'm not sure if .SVG is supposed to work or not, otherwise I'd do a PR to offer a fix)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Add a custom background section in UsingJsonSettings.md and reproduce the JPG and SVG examples. Confirm which image format Terminal supports for backgroundImage, then make the Step 1 download and Step 4 configuration consistent and verify the documented example displays correctly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100