docs(export): remove deprecated flags

This commit is contained in:
Jan De Dobbeleer 2024-03-14 14:46:12 +01:00 committed by Jan De Dobbeleer
parent a7c60c36a5
commit a8f97f5aa2
2 changed files with 2 additions and 5 deletions

View file

@ -109,8 +109,6 @@ Exports the config to an image file using customized output options.`,
func init() { //nolint:gochecknoinits
imageCmd.Flags().StringVar(&author, "author", "", "config author")
imageCmd.Flags().StringVar(&bgColor, "background-color", "", "image background color")
// imageCmd.Flags().IntVar(&cursorPadding, "cursor-padding", 0, "prompt cursor padding")
// imageCmd.Flags().IntVar(&rPromptOffset, "rprompt-offset", 0, "right prompt offset")
imageCmd.Flags().StringVarP(&outputImage, "output", "o", "", "image file (.png) to export to")
exportCmd.AddCommand(imageCmd)
}

View file

@ -16,14 +16,13 @@ The oh-my-posh executable has the `config export image` command to export your c
to an image file (.png).
```powershell
oh-my-posh config export image --cursor-padding 50
oh-my-posh config export image
```
There are a couple of additional flags you can use to tweak the image rendering:
- `--cursor-padding`: spaces to add after the cursor indication (`_`)
- `--rprompt-offset`: spaces to add **before** a block that's right aligned
- `--author`: the name of the creator, added after `ohmyposh.dev`
- `--background-color`: the hex background color to use (e.g. `#222222`)
- `--output`: the file to export to (e.g. `theme.png`)
For all options, and additional examples, use `oh-my-posh config export image --help`