Skip to content

Commit

Permalink
Update readme with missing customization options (charmbracelet#85)
Browse files Browse the repository at this point in the history
* Update readme with missing customization options

* Undo Prettier formatter changes
  • Loading branch information
CodeZea1ot authored May 9, 2024
1 parent 7528893 commit 96bc878
Showing 1 changed file with 40 additions and 3 deletions.
43 changes: 40 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,23 +93,28 @@ Screenshots can be customized with `--flags` or [Configuration](#configuration)
> [!NOTE]
> You can view all freeze customization with `freeze --help`.
- [`-o`](#output), [`--output`](#output): Output location for .svg, .png, .jpg.
- [`-b`](#background), [`--background`](#background): Apply a background fill.
- [`-c`](#configuration), [`--config`](#configuration): Base configuration file or template.
- [`-t`](#theme), [`--theme`](#theme): Theme to use for syntax highlighting.
- [`-l`](#language), [`--language`](#language): Language to apply to code
- [`-w`](#window), [`--window`](#window): Display window controls.
- [`-m`](#margin), [`--margin`](#margin): Apply margin to the window.
- [`-o`](#output), [`--output`](#output): Output location for .svg, .png, .jpg.
- [`-p`](#padding), [`--padding`](#padding): Apply padding to the code.
- [`-r`](#border-radius), [`--border.radius`](#border-radius): Corner radius of window.
- [`-t`](#theme), [`--theme`](#theme): Theme to use for syntax highlighting.
- [`-w`](#window), [`--window`](#window): Display window controls.
- [`-H`](#height), [`--height`](#height): Height of terminal window.
- [`--border.width`](#border-width): Border width thickness.
- [`--border.color`](#border-width): Border color.
- [`--shadow.blur`](#shadow): Shadow Gaussian Blur.
- [`--shadow.x`](#shadow): Shadow offset x coordinate.
- [`--shadow.y`](#shadow): Shadow offset y coordinate.
- [`--font.family`](#font): Font family to use for code.
- [`--font.ligatures`](#font): Use ligatures in the font.
- [`--font.size`](#font): Font size to use for code.
- [`--font.file`](#font): File path to the font to use (embedded in the SVG).
- [`--line-height`](#font): Line height relative to font size.
- [`--show-line-numbers`](#line-numbers): Show line numbers.
- [`--lines`](#line-numbers): Lines to capture (start,end).

### Language

Expand Down Expand Up @@ -169,6 +174,22 @@ freeze artichoke.hs \
You can also embed a font file (in TTF, WOFF, or WOFF2 format) using the
`--font.file` flag.

To use ligatures in the font, you can apply the `--font.ligatures` flag.

### Line Numbers

Show line numbers in the terminal window with the `--show-line-numbers` flag.

```bash
freeze artichoke.hs --show-line-numbers
```

To capture only a specific range of line numbers you can use the `--lines` flag.

```bash
freeze artichoke.hs --show-line-numbers --lines 2,3
```

### Border Radius

Add rounded corners to the terminal.
Expand All @@ -195,6 +216,22 @@ freeze artichoke.hs --window
<img alt="output of freeze command, Haskell code block with window controls applied" src="./test/golden/svg/window.svg" width="600" />
</a>

### Background

Set the background color of the terminal window.

```bash
freeze artichoke.hs --background "#08163f"
```

### Height

Set the height of the terminal window.

```bash
freeze artichoke.hs --height 400
```

### Border Width

Add a border outline to the terminal window.
Expand Down

0 comments on commit 96bc878

Please sign in to comment.