deblan-mirror/gum
deblan-mirror/gum
1
0
Fork 0
mirror of https://github.com/charmbracelet/gum synced 2024-05-15 20:56:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: gum format screenshots

Browse source
This commit is contained in:
Maas Lalani 2022-07-15 11:14:38 -04:00
parent ab825d95ac
commit ac4c08078a
No known key found for this signature in database
GPG key ID: 5A6ED5CBF1A0A000
1 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -200,28 +200,38 @@ markdown, code, template strings, and emoji strings.
For example, we can output a markdown list with the following command:
```bash
gum format "# Gum Formats" "- Markdown" "-Code" "-Template" "- Emoji"
gum format -- "# Gum Formats" "- Markdown" "- Code" "- Template" "- Emoji"
echo "# Gum Formats\n- Markdown\n- Code\n- Template\n- Emoji" | gum format
```
Apply syntax highlighting to code with `gum format code`:
<img src="https://stuff.charm.sh/gum/format-markdown.png" width="250" alt="Format markdown displaying a markdown list with content of different possible formats">
Apply syntax highlighting to code with `gum format -t code`:
```bash
cat main.go | gum format -t code
```
Render a template string:
<img src="https://stuff.charm.sh/gum/format-code.png" width="400" alt="Format code command displaying a simple Hello, world! Go program with syntax highlighting.">
Render a template string with `gum format -t template`:
```bash
echo '{{ Bold "Tasty" }} {{ Italic "Bubble" }} {{ Color "99" "0" " Gum " }}' | gum format -t template
echo '{{ Bold "Tasty" }} {{ Italic "Bubble" }} {{ Color "99" "0" " Gum " }}' \
| gum format -t template
```
Render some emojis with `:emoji:` syntax.
<img src="https://stuff.charm.sh/gum/format-template.png" width="400" alt="Format template command displaying Tasty Bubble Gum in different styles">
Render some emojis with `:emoji:` syntax with `gum format -t emoji`.
```bash
echo 'I :heart: Bubble Gum :candy:' | gum format -t emoji
```
<img src="https://stuff.charm.sh/gum/format-emoji.png" width="400" alt="Format emoji command displaying I :heart: Bubble Gum :candy:.">
## Examples
See the [examples](./examples/) directory for more real world use cases.