Skip to content

Commit

Permalink
update docs about iterm2 image protocol
Browse files Browse the repository at this point in the history
  • Loading branch information
raphamorim committed Sep 9, 2024
1 parent d9071bb commit 846414a
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 9 deletions.
1 change: 0 additions & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/docs/features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Short introduction of Rio terminal features.

- [Vi mode](/docs/features/vi-mode)
- [Hyperlinks](/docs/features/hyperlinks)
- [iTerm image protocol](/docs/features/iterm-image-protocol)
- [iTerm2 image protocol](/docs/features/iterm2-image-protocol)
- [Kitty keyboard protocol](/docs/features/kitty-keyboard-protocol)
- [Rio is fast](/docs/features/rio-is-fast)
- [Adaptive theme](/docs/features/adaptive-theme)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: 'iTerm Image Protocol'
title: 'iTerm2 Image Protocol'
language: 'en'
---

**Note: iTerm Image Protocol is still under development**

Rio implements support for the iTerm2 inline image protocol.

To render an image inline in your terminal, you can use `imgcat` provided as a script by iTerm2 in [iterm2.com/utilities/imgcat](https://iterm2.com/utilities/imgcat) or from other sources like:
Expand All @@ -14,8 +12,6 @@ To render an image inline in your terminal, you can use `imgcat` provided as a s
- [npmjs.com/package/imgcat](https://www.npmjs.com/package/imgcat)
- ... and etecetera.

```bash
imgcat ./rio-logo.png
```
![Demo iTerm2 image protocol](/assets/features/demo-iterm2-image-protocol.png)

More info about [iTerm image protocol](https://iterm2.com/documentation-images.html)
More info regarding [iTerm image protocol](https://iterm2.com/documentation-images.html)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 846414a

Please sign in to comment.