Skip to content

Commit

Permalink
docs: clarify some minor sections
Browse files Browse the repository at this point in the history
  • Loading branch information
hougesen committed Jan 22, 2024
1 parent 676f012 commit 6a3630c
Show file tree
Hide file tree
Showing 11 changed files with 53 additions and 45 deletions.
20 changes: 10 additions & 10 deletions docs/docs/configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,6 @@ blinking-cursor = false

## Hide cursor when typing

Hide the cursor while typing

Default is `false`

```toml
Expand Down Expand Up @@ -94,7 +92,7 @@ padding-x = 10

## Option as Alt

This config only works on MacOs.
This config only works on MacOS.

Possible choices: `both`, `left` and `right`.

Expand All @@ -106,16 +104,14 @@ option-as-alt = 'left'

Directory the shell is started in. If this is unset the working directory of the parent process will be used.

This configuration only works if `use-fork` is disabled.
This configuration only works if [`use-fork`](#use-fork) is disabled.

```toml
working-dir = "/Users/raphael/Documents/"
```

## Environment variables

The example below sets fish as the default SHELL using env vars, please do not copy this if you do not need it.

```toml
env-vars = []
```
Expand Down Expand Up @@ -143,8 +139,12 @@ confirm-before-quit = true

- `width` - define the initial window width.

- Default: `600`

- `height` - define the initial window height.

- Default: `400`

- `mode` - define how the window will be created

- `Windowed` (default) is based on width and height
Expand Down Expand Up @@ -241,7 +241,7 @@ disable-unfocused-render = false

## Fonts

Configure fonts used by the terminal
Configure fonts used by the terminal.

Note: You can set different font families but Rio terminal
will always look for regular font bounds whene
Expand Down Expand Up @@ -308,7 +308,7 @@ You can change how many lines are scrolled each time by setting this option. Scr

If you want a quicker scroll, keep increasing the multiplier. If you want to reduce scroll speed you will need to increase the divider.

You can use both properties also to find the best scroll for you.
You can combine both properties to find the best scroll for you.

- Multiplier default is `3.0`.
- Divider default is `1.0`.
Expand All @@ -325,7 +325,7 @@ divider = 1.0

- `mode` - Define navigation mode

- `NativeTab` (MacOs only)
- `NativeTab` (MacOS only)
- `CollapsedTab`
- `BottomTab`
- `TopTab`
Expand Down Expand Up @@ -420,7 +420,7 @@ You can create custom key bindings for Rio terminal, [more information](/docs/ke
keys = [
{ key = "q", with = "super", action = "Quit" },
# Bytes[27, 91, 53, 126] is equivalent to "\x1b[5~"
{ key = "home", with = "super | shift", bytes = [27, 91, 53, 126] }
{ key = "home", with = "super | shift", bytes = [27, 91, 53, 126] },
]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/features/color-automation-for-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: 'Color automation for navigation'
language: 'en'
---

Rio allows to specify color overwrites for tabs based on program and path contexts, using the `program` and `path` options.
Rio allows specifying color for tabs based on program and path contexts, using the `program` and `path` options.

It is possible to use `program` and `path` at the same time.
It is possible to combine `program` and `path`.

Note: `path` is only available for MacOS, BSD and Linux.

Expand Down Expand Up @@ -51,7 +51,7 @@ color-automation = [

#### Program and path

It is also possible to use both `path` and `program` at the same time.
It is possible to combine `path` and `program`.

The example below sets `#FFFF00` as color background when in the `/home` path and `nvim` is open.

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/features/hyperlinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ title: 'Hyperlinks'
language: 'en'
---

Rio terminal support open hyperlinks from the terminal.
Rio terminal supports opening hyperlinks from the terminal.

## MacOS

For activate hyperlink feature hold `Command` key whenever hovering a link:
To activate hyperlink feature hold `Command` key when hovering a link:

![Demo macos hyperlink](/assets/features/demo-hyperlink-macos.gif)

## Windows / Linux / BSD

For activate hyperlink feature hold `alt` key whenever hovering a link:
To activate hyperlink feature hold `alt` key when hovering a link:

![Demo windows hyperlink](/assets/features/demo-hyperlink-windows.png)

Expand Down Expand Up @@ -43,4 +43,4 @@ Will work as default rio terminal hyperlinks, by holding command or `alt` key (d
printf '\e]8;;https://raphamorim.io/rio/\e\\This is a link\e]8;;\e\\\n'
```

![Demo hyperlink using OSC 8](/assets/features/demo-hyperlink-osc-8.png)
![Demo hyperlink using OSC 8](/assets/features/demo-hyperlink-osc-8.png)
4 changes: 2 additions & 2 deletions docs/docs/features/iterm-image-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ language: 'en'

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

Rio implements support for the iTerm2 inline images protocol.
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 @@ -18,4 +18,4 @@ To render an image inline in your terminal, you can use `imgcat` provided as a s
imgcat ./rio-logo.png
```

More info about [iTerm image protocol](https://iterm2.com/documentation-images.html)
More info about [iTerm image protocol](https://iterm2.com/documentation-images.html)
2 changes: 1 addition & 1 deletion docs/docs/features/spawn-or-fork.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: 'Spawn or Fork'
language: 'en'
---

In POSIX-based systems, Rio spawn processes instead of fork processes due to some compability issues between platforms.
In POSIX-based systems, Rio spawn processes instead of forking due to some compatibility issues between platforms.

However you can also switch from spawn to fork, forking a process is faster than spawning a process.

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Rio is available for:
- [FreeBSD](/docs/install/freebsd)
- [WebAssembly](/docs/install/webassembly)

Rio terminal applications have two type of builds: stable and nightly.
Rio has two type of builds: stable and nightly.

While stable versions are thoroughly tested and takes longer to release, nightly versions are created by daily basis.
While stable versions are thoroughly tested and takes longer to release, nightly versions are created on a daily basis.

[Github releases for Nightly](https://github.com/raphamorim/rio/releases/tag/nightly)
[Github releases for Nightly](https://github.com/raphamorim/rio/releases/tag/nightly)
8 changes: 7 additions & 1 deletion docs/docs/install/using-cargo.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@ title: 'Using cargo'
language: 'en'
---

You can install rio terminal optionally using Cargo, the package manager and crate host for rust. Cargo is available as option for multiple platforms.
Rio can be installed using Cargo, the package manager for Rust.

Cargo is available for most platforms, and is a good alternative to building Rio from source.

Rust and Cargo can be installed from [rust-lang.org](https://www.rust-lang.org/learn/get-started).

You might need to install additional packages depending on your platform. See the guide to [building from source](/docs/install/build-from-source) for more information.

```sh
cargo install rioterm
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If you want to change the default shell to the new PowerShell platform, change t
shell = { program = "pwsh", args = ["--login"] }
```

You may want to use a specific GPU on your system, specially if you're on a laptop configuration, this can enable hardware accelaration and improve performance of the application.
You may want to use a specific GPU on your system, specially if you're on a laptop configuration, this can enable hardware acceleration and improve performance of the application.
To make Windows utilize a GPU for a specific application through Windows display settings, follow the instructions:

1. Simultaneously press the Windows key and the letter "i" on your keyboard to open Windows Settings.
Expand Down
28 changes: 19 additions & 9 deletions docs/docs/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ title: 'Navigation'
language: 'en'
---

Rio allows to choose navigation between the following options:
Rio has multiple styles of showing navigation/tabs.

### CollapsedTab

The `CollapsedTab` is Rio terminal default navigation mode for Linux, BSD and Windows.
`CollapsedTab` is the default navigation mode for Linux, BSD and Windows.

Note: The example below is using Dracula color scheme instead of Rio default colors.
Note: The example below is using the [Dracula](https://github.com/dracula/rio-terminal) color scheme instead of Rio default colors.

<img src="https://miro.medium.com/v2/resize:fit:1400/format:webp/1*gMLWcZkniSHUT6Cb7L06Gg.png" width="60%" />

Expand All @@ -22,7 +22,7 @@ mode = "CollapsedTab"

### NativeTab (MacOS only)

The `NativeTab` is Rio terminal default navigation mode for MacOs.
`NativeTab` is the default navigation mode for MacOS.

Note: NativeTab only works for MacOS.

Expand Down Expand Up @@ -95,18 +95,28 @@ mode = "Plain"

### Color automation for navigation

Rio allows to specify color overwrites for tabs based on program and path contexts, using the `program` and `path` options.

It is possible to use `program` and `path` at the same time.
Rio supports specifying the color of tabs using the `program` and `path` options.

Note: `path` is only available for MacOS, BSD and Linux.

```toml
[navigation]
color-automation = [
# Set tab to red (#FF0000) when NeoVim is open.
{ program = "nvim", color = "#FF0000" },
# Set tab to green (#00FF00) when in the projects folder
{ path = "/home/YOUR_USERNAME/projects", color = "#00FF00" },
# Set tab to blue (#0000FF) when in the Rio folder AND vim is open
{ program = "vim", path = "/home/YOUR_USERNAME/projects/rio", color = "#0000FF" },
]
```

#### Program

The example below sets `#FFFF00` as color background whenever `nvim` is running.

<p>
<img alt="example navigation with program color automation using TopTab" src="/rio/assets/features/demo-colorized-navigation.png" width="48%"/>
<img alt="example navigation with program color automation using BottomTab" src="/rio/assets/features/demo-colorized-navigation.png" width="48%"/>

<img alt="example navigation with program color automation using CollapsedTab" src="/rio/assets/features/demo-colorized-navigation-2.png" width="48%"/>
</p>
Expand Down Expand Up @@ -143,7 +153,7 @@ color-automation = [

#### Program and path

It is also possible to use both `path` and `program` at the same time.
It is possible to use both `path` and `program` at the same time.

The example below sets `#FFFF00` as color background when in the `/home` path and `nvim` is open.

Expand Down
6 changes: 1 addition & 5 deletions docs/docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@ language: 'en'

## Note: Plugins are not ready yet

Plugins in Rio terminal are powered by WebAssembly.

And what it means in pratical terms?

You can write your plugin in any programming language that you want.
Plugins in Rio terminal are powered by WebAssembly. Which means they can be written in any programming language, as long as it is able to be compiled to WebAssembly.

Rio provides hooks and controlling functions to WASM modules that are loaded in initialization time. Let's take a look in a plugin written with JavaScript or Rust.

Expand Down
8 changes: 2 additions & 6 deletions rio-backend/src/config/defaults.rs
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ blinking-cursor = false
# Option as Alt
#
# This config only works on MacOs.
# This config only works on MacOS.
# Possible choices: 'both', 'left' and 'right'.
#
# Example:
Expand All @@ -188,9 +188,6 @@ blinking-cursor = false
# Environment variables
#
# The example below sets fish as the default SHELL using env vars
# please do not copy this if you do not need
#
# Example:
# env-vars = []
Expand All @@ -203,7 +200,6 @@ blinking-cursor = false
# Example:
# use-fork = false
# Confirm before exiting Rio
# Default is `true`
#
Expand Down Expand Up @@ -332,7 +328,7 @@ blinking-cursor = false
# Navigation
#
# "mode" - Define navigation mode
# • NativeTab (MacOs only)
# • NativeTab (MacOS only)
# • CollapsedTab
# • BottomTab
# • TopTab
Expand Down

0 comments on commit 6a3630c

Please sign in to comment.