Skip to content

Commit ad3d0b5

Browse files
authored
Update docs (#326)
* upgrade docusaurus to 3.0 * quote to backtick * fix code highlighting and small formatting * convert tweets to react-tweet component * additional code highlighting * remove brackets from bare url * formatting * fix some markdown issues * add docs format system * run format * update clsx version * format mdx * remove
1 parent 97e4c51 commit ad3d0b5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+4721
-2458
lines changed

docs/.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock.json

docs/blog/2023-05-31-release-0.0.5.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: post
3-
title: "Release 0.0.5"
4-
date: 2023-05-31 10:34:14 +0200
3+
title: 'Release 0.0.5'
4+
date: 2023-05-31 10:34:14 +0200
55
categories: macos linux release
6-
description: "Arrival to Linux, themes support and many bug fixes."
6+
description: 'Arrival to Linux, themes support and many bug fixes.'
77
---
88

99
# Arrival to Linux, Themes support and many bug fixes.
@@ -12,7 +12,7 @@ Rio release 0.0.5 is finally here, there's a lot of updates to cover so let's ge
1212

1313
## New configuration path
1414

15-
Configuration path has changed from "{$HOME}/.rio/" to "{$HOME}/.config/rio".
15+
Configuration path has changed from `{$HOME}/.rio/` to `{$HOME}/.config/rio`.
1616

1717
Changes were applied for macOS and Linux.
1818

@@ -50,6 +50,5 @@ Support to text styling as such "bold" and "italic".
5050
- Fix font-size dependency for serialization
5151
- Fix cursor visibility on VI mode and scroll [#51](https://github.com/raphamorim/#51)
5252
- Performance fixes for rendering from teletypewriter updates.
53-
- Fix scale issues for 1.0 scale factor or using monitor with different scale factor. [#50](https://github.com/raphamorim/rio/issues/
54-
-#50)
55-
- Improved release process to only contain Rio.app file. [#54](https://github.com/raphamorim/rio/issues/#54)
53+
- Fix scale issues for 1.0 scale factor or using monitor with different scale factor. [#50](https://github.com/raphamorim/rio/issues/#50)
54+
- Improved release process to only contain Rio.app file. [#54](https://github.com/raphamorim/rio/issues/#54)

docs/blog/2023-06-07-release-0.0.6.md renamed to docs/blog/2023-06-07-release-0.0.6.mdx

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
22
layout: post
3-
title: "Release 0.0.6"
4-
date: 2023-06-07 10:34:14 +0200
3+
title: 'Release 0.0.6'
4+
date: 2023-06-07 10:34:14 +0200
55
categories: macos linux release
6-
description: "Tabs support, underline and beam cursor, text styles and many bug fixes."
6+
description: 'Tabs support, underline and beam cursor, text styles and many bug fixes.'
77
---
88

9+
import { Tweet } from 'react-tweet';
10+
911
# Tabs support, underline and beam cursor, text styles and many bug fixes.
1012

1113
Rio release 0.0.6 is finally here, there's a lot of updates to cover so let's get started. I also would like to remind you that Rio is still unstable. This release adds a lot of bug fixes and feature additions in order to make Rio terminal stable.
@@ -14,7 +16,6 @@ Rio release 0.0.6 is finally here, there's a lot of updates to cover so let's ge
1416

1517
Support to text styling as such "Underline" and "Strikethrough".
1618

17-
1819
## Tabs support
1920

2021
Tabs has been added to Rio terminal for macos and linux platform.
@@ -27,15 +28,15 @@ The shortcuts:
2728

2829
Below you can see an example of usage:
2930

30-
<blockquote class="twitter-tweet" data-lang="en" data-dnt="true" data-theme="dark"><p lang="en" dir="ltr">Tabs 🦀⏳🌈<br/><br/>(In the future Rio will provide an external API for rendering widgets in the terminal, so people can write their own implementation of tabs or even things like telescope for terminal GUI level)<a href="https://twitter.com/hashtag/Rust?src=hash&amp;ref_src=twsrc%5Etfw">#Rust</a> <a href="https://t.co/ZnilDIEpP5">https://t.co/ZnilDIEpP5</a> <a href="https://t.co/NCYF4j8rt2">pic.twitter.com/NCYF4j8rt2</a></p>&mdash; Raphael Amorim 🦀 (@raphamorims) <a href="https://twitter.com/raphamorims/status/1664585160958922755?ref_src=twsrc%5Etfw">June 2, 2023</a></blockquote>
31+
<Tweet id="1664585160958922755" />
3132

3233
Note: There's a limit of maximum of 6 tabs for now.
3334

3435
## Support to Beam and Underline cursors
3536

3637
Beam and underline cursor support has been added to Rio terminal. Also, block cursor and IME state allow a character to be visible.
3738

38-
<blockquote class="twitter-tweet" data-lang="en" data-dnt="true" data-theme="dark"><p lang="en" dir="ltr">Rio terminal updates: <br/><br/>- Support to Beam and Underline cursors <a href="https://t.co/UJwhFeZnTy">https://t.co/UJwhFeZnTy</a> by <a href="https://twitter.com/xiuez?ref_src=twsrc%5Etfw">@xiuez</a> ⭐️<br/>- Now block cursor and IME state allow a character to be visible. <a href="https://twitter.com/hashtag/Rust?src=hash&amp;ref_src=twsrc%5Etfw">#Rust</a> <a href="https://t.co/5EuJJzPsB2">https://t.co/5EuJJzPsB2</a> <a href="https://t.co/NxoxP69utJ">pic.twitter.com/NxoxP69utJ</a></p>&mdash; Raphael Amorim 🦀 (@raphamorims) <a href="https://twitter.com/raphamorims/status/1664146499398139906?ref_src=twsrc%5Etfw">June 1, 2023</a></blockquote>
39+
<Tweet id="1664146499398139906" />
3940

4041
## Changelog
4142

@@ -49,5 +50,3 @@ Beam and underline cursor support has been added to Rio terminal. Also, block cu
4950
- Support to caret Beam and Underline cursor [#67](https://github.com/raphamorim/rio/issues/67) by [@niuez](https://github.com/niuez).
5051
- Fix panics if custom font is not found [#68](https://github.com/raphamorim/rio/issues/68).
5152
- MacOs ignore alt key in cntrlseq (same behavior as Terminal.app, Hyper, iTerm and etecetera).
52-
53-
<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

docs/blog/2023-07-07-release-0.0.7.md renamed to docs/blog/2023-07-07-release-0.0.7.mdx

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: post
3-
title: "Rio 0.0.7"
4-
date: 2023-07-07 12:34
5-
description: "Configuration reload, x11 and wayland stabilization, sugarloaf ported to WebAssembly, addition to NIX OS packages and other updates."
3+
title: 'Rio 0.0.7'
4+
date: 2023-07-07 12:34
5+
description: 'Configuration reload, x11 and wayland stabilization, sugarloaf ported to WebAssembly, addition to NIX OS packages and other updates.'
66
categories: release macos linux webassembly
77
---
88

9-
<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
9+
import { Tweet } from 'react-tweet';
1010

11-
# v0.0.7: Highlights
11+
## v0.0.7: Highlights
1212

1313
- Support to custom fonts
1414
- Configuration reload
@@ -17,9 +17,7 @@ categories: release macos linux webassembly
1717
- Addition to NIX OS packages (kudos to [@otavio](https://github.com/otavio), PR: [NixOS/nixpkgs/pull/237664](https://github.com/NixOS/nixpkgs/pull/237664))
1818
- Styles properties have been moved to root level
1919

20-
<br/>
21-
22-
# Overview
20+
## Overview
2321

2422
Rio release 0.0.7 is finally here, there's a lot of updates to cover so let's get started. I also would like to remind you that Rio is still unstable. This release adds a lot of bug fixes and feature additions in order to make Rio terminal stable.
2523

@@ -34,7 +32,7 @@ cursor = '|'
3432
[style]
3533
font-size = 18
3634
theme = "lucario"
37-
{% endhighlight %}
35+
```
3836

3937
After:
4038

@@ -44,14 +42,12 @@ theme = "lucario"
4442
font-size = 18
4543
```
4644

47-
4845
## Reload automatically when the configuration file has changed.
4946

5047
Any file update in the configuration file will trigger a render operation in Rio terminal with the new configuration.
5148

5249
If you have any suggestion of configuration ideas to Rio, please feel free to [open an issue](https://github.com/raphamorim/rio/issues/new).
5350

54-
5551
## width and height is not longer available in the configuration file.
5652

5753
The property witdh and height doesn't work anymore after the 0.0.7 release.
@@ -64,8 +60,7 @@ In older versions of Rio terminal it was possible to actually use Rio but it was
6460

6561
The tweet below have a video demo that shows Rio running with X11:
6662

67-
<blockquote class="twitter-tweet" data-lang="en" data-dnt="true" data-theme="light"><p lang="en" dir="ltr">sneak peek at Rio terminal for Linux X11 builds in the next version (0.0.7) <a href="https://t.co/5EuJJzPsB2">https://t.co/5EuJJzPsB2</a> <a href="https://twitter.com/hashtag/rustlang?src=hash&amp;ref_src=twsrc%5Etfw">#rustlang</a> <a href="https://t.co/JeWmPju9FT">pic.twitter.com/JeWmPju9FT</a></p>&mdash; Raphael Amorim 🦀 (@raphamorims) <a href="https://twitter.com/raphamorims/status/1670404595246419968?ref_src=twsrc%5Etfw">June 18, 2023</a></blockquote>
68-
63+
<Tweet id="1670404595246419968" />
6964

7065
## Custom font rendering
7166

@@ -79,15 +74,14 @@ font = "Fira code"
7974

8075
A quick look of how font updates looks like in v0.0.7:
8176

82-
<blockquote class="twitter-tweet" data-lang="en" data-dnt="true"><p lang="en" dir="ltr">stabilization of custom font rendering for upcoming version of Rio terminal<a href="https://t.co/5EuJJzPsB2">https://t.co/5EuJJzPsB2</a> <a href="https://twitter.com/hashtag/rust?src=hash&amp;ref_src=twsrc%5Etfw">#rust</a> <a href="https://t.co/HLTLG8Yovz">pic.twitter.com/HLTLG8Yovz</a></p>&mdash; Raphael Amorim 🦀 (@raphamorims) <a href="https://twitter.com/raphamorims/status/1670808836213547009?ref_src=twsrc%5Etfw">June 19, 2023</a></blockquote>
77+
<Tweet id="1670808836213547009" />
8378

8479
## Sugarloaf ported to WebAssembly
8580

8681
The Rio support to WASM has moved one step ahead by introduction of Sugarloaf (Rio renderer) to WebAssembly.
8782

8883
In the image below you can see it in action:
8984

90-
9185
## Changelog of v0.0.7
9286

9387
- Breaking changes for configuration file regarding "Style" property.

docs/blog/2023-07-10-release-0.0.8.md renamed to docs/blog/2023-07-10-release-0.0.8.mdx

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
22
layout: post
3-
title: "Rio 0.0.8"
4-
date: 2023-07-03 12:34
5-
description: "Support to Microsoft Windows, Homebrew casks and formulas, migration to Corcovado, selection improvements and increase/decrease font-size in a session."
3+
title: 'Rio 0.0.8'
4+
date: 2023-07-03 12:34
5+
description: 'Support to Microsoft Windows, Homebrew casks and formulas, migration to Corcovado, selection improvements and increase/decrease font-size in a session.'
66
categories: release windows macos linux
77
---
88

9-
<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
9+
import { Tweet } from 'react-tweet';
1010

11-
# v0.0.8: Highlights
11+
## v0.0.8: Highlights
1212

1313
- Support to Microsoft Windows.
1414
- Support to Homebrew as cask [formulae.brew.sh/cask/rio](https://formulae.brew.sh/cask/rio).
1515
- Support to Homebrew as formula [formulae.brew.sh/formula/rio](https://formulae.brew.sh/formula/rio).
1616
- Selection improvements and increase/decrease font-size in a session.
1717
- Migration to Corcovado.
1818

19-
<br/>
19+
<br />
2020

2121
# Overview
2222

@@ -38,38 +38,37 @@ Homebrew is a free and open-source software package management system that simpl
3838

3939
Rio has been added as a cask [formulae.brew.sh/cask/rio](https://formulae.brew.sh/cask/rio) to their package source. To install Rio with homebrew you need to run the command below:
4040

41-
{% highlight javascript %}
41+
```sh
4242
brew update && brew install --cask rio
43-
{% endhighlight %}
43+
```
4444

4545
Github reference: [github.com/Homebrew/homebrew-cask/pull/149824](https://github.com/Homebrew/homebrew-cask/pull/149824)
4646

4747
## Homebrew as Formula
4848

4949
Rio has been added as a formula [formulae.brew.sh/formula/rio](https://formulae.brew.sh/formula/rio) to their package source. To install Rio with homebrew you need to run the command below:
5050

51-
{% highlight javascript %}
51+
```sh
5252
brew update && brew install rio
53-
{% endhighlight %}
53+
```
5454

5555
Github reference: [github.com/Homebrew/homebrew-cask/pull/149824](https://github.com/Homebrew/homebrew-core/pull/134295)
5656

57-
## Selection improvements and increase/decrease font-size in a session
57+
## Selection improvements and increase/decrease font-size in a session
5858

5959
The version v0.0.8 has added the following missing functionalities: Scroll and select, Semantic and line selection and the ability to increase, decrease and reset font size using keyboard shortcut during session coming for Rio terminal.
6060

6161
Below you can see a demo with all those functionalities:
6262

63-
<blockquote class="twitter-tweet" data-lang="en"><p lang="en" dir="ltr">Coming for next Rio terminal version (v0.0.8)<br/><br/>- Scroll and select.<br/>- Semantic and line selection.<br/>- Ability to in|decrease font size using keyboard shortcut during session coming for Rio terminal<a href="https://t.co/5EuJJzPsB2">https://t.co/5EuJJzPsB2</a> <a href="https://twitter.com/hashtag/rust?src=hash&amp;ref_src=twsrc%5Etfw">#rust</a> <a href="https://t.co/45Nt3pHtJ3">pic.twitter.com/45Nt3pHtJ3</a></p>&mdash; Raphael Amorim 🦀 (@raphamorims) <a href="https://twitter.com/raphamorims/status/1673705339336761344?ref_src=twsrc%5Etfw">June 27, 2023</a>
64-
</blockquote>
63+
<Tweet id="1673705339336761344" />
6564

6665
## Migration to Corcovado
6766

6867
Rio terminal migrated from Mio to Corcovado. Corcovado is a maintained fork of mio 0.6.x along mio-signal-hook, mio-extras and using Windows API that works in Windows 11. It uses Rust edition 2021 instead of 2018.
6968

7069
Corcovado also uses Rust standard library for net and io instead of Mio 0.6.x.
7170

72-
<br/>
71+
<br />
7372

7473
## Changelog of v0.0.8
7574

docs/blog/2023-07-17-release-0.0.9.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
layout: post
3-
title: "Rio 0.0.9"
4-
date: 2023-07-17 12:34
5-
description: "Multi window support, FreeBSD support, possibility of choose between Spawn and Fork, inverse instruction, multi byte rendering fixes, support to older MacOS versions, select shell and working-dir in configuration file."
3+
title: 'Rio 0.0.9'
4+
date: 2023-07-17 12:34
5+
description: 'Multi window support, FreeBSD support, possibility of choose between Spawn and Fork, inverse instruction, multi byte rendering fixes, support to older MacOS versions, select shell and working-dir in configuration file.'
66
categories: release windows macos linux
77
---
88

@@ -76,7 +76,7 @@ After about 1980, many terminals supported over a hundred different commands (so
7676

7777
Rio terminal has now it's own terminfo:
7878

79-
```lisp
79+
```sh
8080
$ echo $TERM
8181
rio
8282
```
@@ -104,6 +104,7 @@ shell = { program = "/bin/zsh", args = ["--login"] }
104104
```
105105

106106
Defaults:
107+
107108
- MacOS: /bin/zsh --login
108109
- Linux/BSD: user login shell
109110
- Windows: powershell

docs/blog/2023-07-19-release-0.0.11.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
layout: post
3-
title: "Rio 0.0.11"
4-
date: 2023-07-19 12:34
5-
description: "Performance improvements around 80-110%, binary size optimization, usage of pixel scale and others."
3+
title: 'Rio 0.0.11'
4+
date: 2023-07-19 12:34
5+
description: 'Performance improvements around 80-110%, binary size optimization, usage of pixel scale and others.'
66
categories: release windows macos linux
77
---
88

99
# v0.0.11: Changelog
1010

1111
Example of Rio v0.0.11 using the new sugarloaf:
1212

13-
1413
v0.0.11 includes v0.0.10 with a bug fix of CachedSugar for font styles.
1514

1615
- Major rewrote of sugarloaf.

docs/blog/2023-08-02-release-0.0.15.md renamed to docs/blog/2023-08-02-release-0.0.15.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
---
22
layout: post
3-
title: "Support to tabs, custom key bindings, performance improvements and other updates"
4-
date: 2023-08-02 12:34
5-
description: "Support to tabs, custom key bindings, performance improvements, color automation for tabs, binary size optimization, bug fixes and other updates."
3+
title: 'Support to tabs, custom key bindings, performance improvements and other updates'
4+
date: 2023-08-02 12:34
5+
description: 'Support to tabs, custom key bindings, performance improvements, color automation for tabs, binary size optimization, bug fixes and other updates.'
66
categories: windows macos linux webassembly
77
---
88

9+
import { Tweet } from 'react-tweet';
10+
911
This post also includes changes from v0.0.13 and v0.0.12.
1012

11-
# Highlights
13+
## Highlights
1214

1315
- Navigation.
1416
- Custom key bindings.
@@ -67,7 +69,7 @@ The de-duplication algorithm in the renderer considerably reduced the initial re
6769

6870
Tweet reference:
6971

70-
<blockquote class="twitter-tweet"><p lang="ca" dir="ltr">Rewriting Sugarloaf (Rio terminal renderer) to de-duplicate data inputs.<br/><br/>- Results so far:<br/>Before: ~253.5µs<br/>Now: ~51.5µs<br/><br/>Github: <a href="https://t.co/5EuJJzPsB2">https://t.co/5EuJJzPsB2</a> <a href="https://t.co/8hj2Ku4Otn">pic.twitter.com/8hj2Ku4Otn</a></p>&mdash; Raphael Amorim 🦀 (@raphamorims) <a href="https://twitter.com/raphamorims/status/1685612156773961728?ref_src=twsrc%5Etfw">July 30, 2023</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
72+
<Tweet id="1685612156773961728" />
7173

7274
## Color automation for navigation
7375

docs/blog/2023-08-29-release-0.0.17.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: post
3-
title: "New font configuration API and native tabs"
4-
date: 2023-08-29 17:53
5-
description: "Rio terminal release: New font configuration API, native tabs, kitty keyboard protocol and other stuff."
3+
title: 'New font configuration API and native tabs'
4+
date: 2023-08-29 17:53
5+
description: 'Rio terminal release: New font configuration API, native tabs, kitty keyboard protocol and other stuff.'
66
categories: windows macos linux webassembly
77
---
88

99
This post also includes changes from v0.0.16 and v0.0.17.
1010

11-
# Highlights
11+
## Highlights
1212

1313
- New font configuration API.
1414
- Native Tabs for MacOS.

docs/blog/2023-09-19-release-0.0.19.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
layout: post
3-
title: "Settings UI, Welcome UI, Adaptive theme, crates.io and more"
4-
date: 2023-09-19 13:53
5-
description: "Crates.io, Alpine Linux, openSUSE, Nix home manager, adaptive theme, settings UI, welcome UI, blinking cursor, plain navigation mode ..."
3+
title: 'Settings UI, Welcome UI, Adaptive theme, crates.io and more'
4+
date: 2023-09-19 13:53
5+
description: 'Crates.io, Alpine Linux, openSUSE, Nix home manager, adaptive theme, settings UI, welcome UI, blinking cursor, plain navigation mode ...'
66
categories: windows macos linux webassembly
77
---
88

@@ -60,13 +60,13 @@ Although you can define opacity though the new configuration API it does not wor
6060

6161
![Example background](https://media.discordapp.net/attachments/1110689410258841662/1152881776348364811/F6JGpamXsAAWvcG.png?width=1048&height=848)
6262

63-
note: The image above is from the [Eastward game](https://en.wikipedia.org/wiki/Eastward_(video_game))
63+
note: The image above is from the [Eastward game](<https://en.wikipedia.org/wiki/Eastward_(video_game)>)
6464

6565
## Highlight #2: crates.io
6666

6767
Rio terminal is now also available in crates.io: https://crates.io/crates/rioterm .
6868

69-
```bash
69+
```sh
7070
cargo install rioterm
7171
```
7272

0 commit comments

Comments
 (0)