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

docs(format): Add gum format docs

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

30
README.md
View file

@ -192,6 +192,36 @@ gum join --align center --vertical "$I_LOVE" "$BUBBLE_GUM"
<img src="https://stuff.charm.sh/gum/join.png" width="600" alt="I LOVE Bubble Gum written out in four boxes with double borders around them.">
#### Format
Format allows you to take some text and stylize it. `gum format` can parse
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"
echo "# Gum Formats\n- Markdown\n- Code\n- Template\n- Emoji" | gum format
```
Apply syntax highlighting to code with `gum format code`:
```bash
cat main.go | gum format -t code
```
Render a template string:
```bash
echo '{{ Bold "Tasty" }} {{ Italic "Bubble" }} {{ Color "99" "0" " Gum " }}' | gum format -t template
```
Render some emojis with `:emoji:` syntax.
```bash
echo 'I :heart: Bubble Gum :candy:' | gum format -t emoji
```
## Examples
See the [examples](./examples/) directory for more real world use cases.