From e197b227c81c33ce5f077ed6b0f6773f9e1cd8e3 Mon Sep 17 00:00:00 2001 From: Raphael Amorim Date: Wed, 15 May 2024 17:42:05 +0200 Subject: [PATCH] update docs and rustfmt --- README.md | 8 ++++---- docs/blog/2023-05-31-release-0.0.5.md | 2 +- docs/blog/2023-07-17-release-0.0.9.md | 2 +- docs/blog/2023-08-02-release-0.0.15.mdx | 4 ++-- ... => 2024-04-18-looking-ahead-to-0.1.0.mdx} | 6 +++--- docs/docs/features/spawn-or-fork.md | 2 +- docs/docs/features/vi-mode.md | 2 +- docs/docs/frequently-asked-questions/index.md | 2 +- docs/docusaurus.config.js | 8 ++++---- .../command-line-interface.md | 0 .../configuration-file.md | 4 ++-- .../default-colors.md | 0 .../escape-sequence-support.md | 0 .../features/adaptive-theme.md | 0 .../color-automation-for-navigation.md | 0 .../features/hyperlinks.md | 0 .../version-0.0.x/features/index.md | 20 +++++++++++++++++++ .../features/kitty-keyboard-protocol.md | 0 .../features/multi-windows.md | 0 .../features/navigation.md | 2 +- .../features/rio-is-fast.md | 0 .../features/spawn-or-fork.md | 2 +- .../features/vi-mode.md | 2 +- .../frequently-asked-questions/index.md | 2 +- .../install/build-from-source.md | 0 .../install/freebsd.md | 0 .../install/index.md | 10 +++++----- .../install/linux.md | 2 +- .../install/macos.md | 0 .../install/terminfo.md | 0 .../install/using-cargo.md | 2 +- .../install/webassembly.md | 0 .../install/windows.md | 2 +- .../key-bindings.md | 0 .../navigation.md | 0 .../plugins.md | 0 .../themes.md | 0 .../version-0.x.x/features/index.md | 20 ------------------- ...ebars.json => version-0.0.x-sidebars.json} | 0 docs/versions.json | 2 +- rustfmt.toml | 1 - 41 files changed, 53 insertions(+), 54 deletions(-) rename docs/blog/{2024-04-18-looking-ahead-to-1.0.0.mdx => 2024-04-18-looking-ahead-to-0.1.0.mdx} (89%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/command-line-interface.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/configuration-file.md (98%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/default-colors.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/escape-sequence-support.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/features/adaptive-theme.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/features/color-automation-for-navigation.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/features/hyperlinks.md (100%) create mode 100644 docs/versioned_docs/version-0.0.x/features/index.md rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/features/kitty-keyboard-protocol.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/features/multi-windows.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/features/navigation.md (92%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/features/rio-is-fast.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/features/spawn-or-fork.md (81%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/features/vi-mode.md (98%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/frequently-asked-questions/index.md (97%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/install/build-from-source.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/install/freebsd.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/install/index.md (61%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/install/linux.md (91%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/install/macos.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/install/terminfo.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/install/using-cargo.md (88%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/install/webassembly.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/install/windows.md (96%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/key-bindings.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/navigation.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/plugins.md (100%) rename docs/versioned_docs/{version-0.x.x => version-0.0.x}/themes.md (100%) delete mode 100644 docs/versioned_docs/version-0.x.x/features/index.md rename docs/versioned_sidebars/{version-0.x.x-sidebars.json => version-0.0.x-sidebars.json} (100%) diff --git a/README.md b/README.md index e17d8949..57cc685d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Rio terminal -🚧 ⚠️ Currently, Rio is in the process of a major rewrite to 1.0.0 to bring more features and fix known issues of 0.x.0 versions. +🚧 ⚠️ Currently, Rio is in the process of a major rewrite to 0.1.x to bring more features and fix known issues of 0.0.x versions. > tl;dr: Rio is a terminal built to run everywhere, as a native desktop applications by Rust or even in the browser powered by WebAssembly. @@ -12,9 +12,9 @@ | Name | Details | | --- | --- | -| MacOs _as desktop application_ | [Installation guide](https://raphamorim.io/rio/docs/0.x.x/install/macos) | -| Linux _as desktop application_ | [Installation guide](https://raphamorim.io/rio/docs/0.x.x/install/linux) | -| Windows _as desktop application_ | [Installation guide](https://raphamorim.io/rio/docs/0.x.x/install/windows) | +| MacOs _as desktop application_ | [Installation guide](https://raphamorim.io/rio/docs/0.0.x/install/macos) | +| Linux _as desktop application_ | [Installation guide](https://raphamorim.io/rio/docs/0.0.x/install/linux) | +| Windows _as desktop application_ | [Installation guide](https://raphamorim.io/rio/docs/0.0.x/install/windows) | | Web Browser _(WebAssembly)_ | (Sugarloaf is ready but Rio still need to be ported) | ## Demo Gallery diff --git a/docs/blog/2023-05-31-release-0.0.5.md b/docs/blog/2023-05-31-release-0.0.5.md index 771dc5c5..125a8e56 100644 --- a/docs/blog/2023-05-31-release-0.0.5.md +++ b/docs/blog/2023-05-31-release-0.0.5.md @@ -18,7 +18,7 @@ Changes were applied for macOS and Linux. ## Linux Support -Rio is now available to Linux, build information was added in the [install](/docs/0.x.x/install) page. +Rio is now available to Linux, build information was added in the [install](/docs/0.0.x/install) page. ![Linux support](/assets/posts/0.0.5/linux.jpeg) diff --git a/docs/blog/2023-07-17-release-0.0.9.md b/docs/blog/2023-07-17-release-0.0.9.md index 63bf09c3..cbb9fbe3 100644 --- a/docs/blog/2023-07-17-release-0.0.9.md +++ b/docs/blog/2023-07-17-release-0.0.9.md @@ -81,7 +81,7 @@ $ echo $TERM rio ``` -More info [here](/docs/0.x.x/install#terminfo). +More info [here](/docs/0.0.x/install#terminfo). ## Fixes for multi-byte rendering diff --git a/docs/blog/2023-08-02-release-0.0.15.mdx b/docs/blog/2023-08-02-release-0.0.15.mdx index f7e213ef..62ef76b6 100644 --- a/docs/blog/2023-08-02-release-0.0.15.mdx +++ b/docs/blog/2023-08-02-release-0.0.15.mdx @@ -53,7 +53,7 @@ Below some images with different navigation setups: ![example BottomTab navigation macos](/assets/features/demo-bottom-tab.png) -More info about navigation in [docs/navigation](/docs/0.x.x/navigation/). +More info about navigation in [docs/navigation](/docs/0.0.x/navigation/). ## Sugarloaf performance improvements @@ -106,7 +106,7 @@ keys = [ For example, in the first binding will tell Rio to close the terminal every time that "q" key is pressed along with "super" (in MacOS the "super" key is "command"). -More info about custom key bindings in [docs/key-bindings](/docs/0.x.x/key-bindings/). +More info about custom key bindings in [docs/key-bindings](/docs/0.0.x/key-bindings/). ## Changelog of v0.0.15 along with 0.0.13 and 0.0.12 diff --git a/docs/blog/2024-04-18-looking-ahead-to-1.0.0.mdx b/docs/blog/2024-04-18-looking-ahead-to-0.1.0.mdx similarity index 89% rename from docs/blog/2024-04-18-looking-ahead-to-1.0.0.mdx rename to docs/blog/2024-04-18-looking-ahead-to-0.1.0.mdx index 8ca1c46b..87b95fed 100644 --- a/docs/blog/2024-04-18-looking-ahead-to-1.0.0.mdx +++ b/docs/blog/2024-04-18-looking-ahead-to-0.1.0.mdx @@ -1,6 +1,6 @@ --- layout: post -title: 'Looking ahead to 1.0.0' +title: 'Looking ahead to 0.1.0' date: 2024-04-18 00:34 description: "Let's talk about what's comming to Rio terminal" categories: windows macos linux @@ -14,9 +14,9 @@ The Rio Terminal is a side project based on my free time (low this year due to b As I open-sourced Rio, many people started to use and eventually requests came in, making me realize that parts of the terminal would have to evolve to comprehend such requests and would eventually mean a rewrite of core parts along with incremental changes in other parts. -I have been working on 1.0.0 release since last December and still have a lot to be done ([Github backlog for 1.0.0](https://github.com/users/raphamorim/projects/6/views/1)). It is hard to give an estimation because there's no regular promised cadence and, I am not in a rush because it will require a lot of further testing and writing a lot of tests as well. Releases are likely to be made in small versions, is very likely that 1.0.0 will start with MacOS with Windows (I hope so at least). +I have been working on 0.1.0 release since last December and still have a lot to be done ([Github backlog for 0.1.0](https://github.com/users/raphamorim/projects/6/views/1)). It is hard to give an estimation because there's no regular promised cadence and, I am not in a rush because it will require a lot of further testing and writing a lot of tests as well. Releases are likely to be made in small versions, is very likely that 0.1.0 will start with MacOS with Windows (I hope so at least). -Summary of 1.0.0 goals: +Summary of 0.1.0 goals: - Split screens. - Stabilization of different fonts besides the default one. diff --git a/docs/docs/features/spawn-or-fork.md b/docs/docs/features/spawn-or-fork.md index 2679bbcb..d35f26dd 100644 --- a/docs/docs/features/spawn-or-fork.md +++ b/docs/docs/features/spawn-or-fork.md @@ -7,4 +7,4 @@ In POSIX-based systems, Rio spawn processes instead of forking due to some compa However you can also switch from spawn to fork, forking a process is faster than spawning a process. -See how to configure it in the advanced section [here](/docs/0.x.x/configuration-file). +See how to configure it in the advanced section [here](/docs/0.0.x/configuration-file). diff --git a/docs/docs/features/vi-mode.md b/docs/docs/features/vi-mode.md index aeeee5d8..84f46453 100644 --- a/docs/docs/features/vi-mode.md +++ b/docs/docs/features/vi-mode.md @@ -9,7 +9,7 @@ By default you can launch Vi mode by using `alt` + `shift` + `space`. ![Demo Vi mode](/assets/features/demo-vi-mode.gif) -Below you can see the list of all default key bindings related to Vi mode. If you don't like of any specified key binding you can always turn off or modify (check [key bindings documentation section](/docs/0.x.x/key-bindings) for more information). +Below you can see the list of all default key bindings related to Vi mode. If you don't like of any specified key binding you can always turn off or modify (check [key bindings documentation section](/docs/0.0.x/key-bindings) for more information). | Trigger | Action | Condition | | :------------------------ | :------------------------- | :------------------- | diff --git a/docs/docs/frequently-asked-questions/index.md b/docs/docs/frequently-asked-questions/index.md index f6c31eb4..0f7988c1 100644 --- a/docs/docs/frequently-asked-questions/index.md +++ b/docs/docs/frequently-asked-questions/index.md @@ -7,7 +7,7 @@ language: 'en' The famous case of "'rio' unknown terminal type". -All the issues all have the same root cause: the rio terminfo is not available. The most common way this happens is SSHing into a computer that does not have the rio terminfo files. The simplest fix would be install the terminfo files on the remote machine (following terminfo instruction in install section [install/terminfo](/docs/0.x.x/install/terminfo)) +All the issues all have the same root cause: the rio terminfo is not available. The most common way this happens is SSHing into a computer that does not have the rio terminfo files. The simplest fix would be install the terminfo files on the remote machine (following terminfo instruction in install section [install/terminfo](/docs/0.0.x/install/terminfo)) Other alternative is use a different terminfo either in config or per connection with environment variable like `TERM=xterm-256color ssh`. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 0186f89d..b90f7d22 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -70,16 +70,16 @@ const config = { disableVersioning: false, includeCurrentVersion: true, lastVersion: undefined, - onlyIncludeVersions: ['current', '0.x.x'], + onlyIncludeVersions: ['current', '0.0.x'], versions: { current: { label: '1.0.0 (unreleased)', path: 'next', banner: 'none', }, - '0.x.x': { - label: '0.x.x', - path: '0.x.x', + '0.0.x': { + label: '0.0.x', + path: '0.0.x', banner: 'none', }, }, diff --git a/docs/versioned_docs/version-0.x.x/command-line-interface.md b/docs/versioned_docs/version-0.0.x/command-line-interface.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/command-line-interface.md rename to docs/versioned_docs/version-0.0.x/command-line-interface.md diff --git a/docs/versioned_docs/version-0.x.x/configuration-file.md b/docs/versioned_docs/version-0.0.x/configuration-file.md similarity index 98% rename from docs/versioned_docs/version-0.x.x/configuration-file.md rename to docs/versioned_docs/version-0.0.x/configuration-file.md index e653aad8..ed59426f 100644 --- a/docs/versioned_docs/version-0.x.x/configuration-file.md +++ b/docs/versioned_docs/version-0.0.x/configuration-file.md @@ -333,7 +333,7 @@ divider = 1.0 - `Plain` - `clickable` - Enable click on tabs to switch. -- `use-current-path` - Use same path whenever a new tab is created (Note: requires [`use-fork`](/docs/0.x.x/configuration-file/#use-fork) to be set to false). +- `use-current-path` - Use same path whenever a new tab is created (Note: requires [`use-fork`](/docs/0.0.x/configuration-file/#use-fork) to be set to false). - `color-automation` - Set a specific color for the tab whenever a specific program is running, or in a specific directory. ```toml @@ -413,7 +413,7 @@ yellow = '#FCBA28' ## Bindings -You can create custom key bindings for Rio terminal, [more information](/docs/0.x.x/key-bindings#custom-key-bindings) +You can create custom key bindings for Rio terminal, [more information](/docs/0.0.x/key-bindings#custom-key-bindings) ```toml [bindings] diff --git a/docs/versioned_docs/version-0.x.x/default-colors.md b/docs/versioned_docs/version-0.0.x/default-colors.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/default-colors.md rename to docs/versioned_docs/version-0.0.x/default-colors.md diff --git a/docs/versioned_docs/version-0.x.x/escape-sequence-support.md b/docs/versioned_docs/version-0.0.x/escape-sequence-support.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/escape-sequence-support.md rename to docs/versioned_docs/version-0.0.x/escape-sequence-support.md diff --git a/docs/versioned_docs/version-0.x.x/features/adaptive-theme.md b/docs/versioned_docs/version-0.0.x/features/adaptive-theme.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/features/adaptive-theme.md rename to docs/versioned_docs/version-0.0.x/features/adaptive-theme.md diff --git a/docs/versioned_docs/version-0.x.x/features/color-automation-for-navigation.md b/docs/versioned_docs/version-0.0.x/features/color-automation-for-navigation.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/features/color-automation-for-navigation.md rename to docs/versioned_docs/version-0.0.x/features/color-automation-for-navigation.md diff --git a/docs/versioned_docs/version-0.x.x/features/hyperlinks.md b/docs/versioned_docs/version-0.0.x/features/hyperlinks.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/features/hyperlinks.md rename to docs/versioned_docs/version-0.0.x/features/hyperlinks.md diff --git a/docs/versioned_docs/version-0.0.x/features/index.md b/docs/versioned_docs/version-0.0.x/features/index.md new file mode 100644 index 00000000..5594f61f --- /dev/null +++ b/docs/versioned_docs/version-0.0.x/features/index.md @@ -0,0 +1,20 @@ +--- +title: 'Features' +language: 'en' +--- + +Rio is available for Microsoft Windows, Linux distros, FreeBSD and Apple MacOS. + +Short introduction of Rio terminal features. + +- [Vi mode](/docs/0.0.x/features/vi-mode) +- [Hyperlinks](/docs/0.0.x/features/hyperlinks) +- [Kitty keyboard protocol](/docs/0.0.x/features/kitty-keyboard-protocol) +- [Rio is fast](/docs/0.0.x/features/rio-is-fast) +- [Adaptive theme](/docs/0.0.x/features/adaptive-theme) +- [Multi windows](/docs/0.0.x/features/multi-windows) +- [Navigation](/docs/0.0.x/features/navigation) +- [Color automation for navigation](/docs/0.0.x/features/color-automation-for-navigation) +- [Spawn or Fork](/docs/0.0.x/features/spawn-or-fork) + +Note: Many other features are in development. diff --git a/docs/versioned_docs/version-0.x.x/features/kitty-keyboard-protocol.md b/docs/versioned_docs/version-0.0.x/features/kitty-keyboard-protocol.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/features/kitty-keyboard-protocol.md rename to docs/versioned_docs/version-0.0.x/features/kitty-keyboard-protocol.md diff --git a/docs/versioned_docs/version-0.x.x/features/multi-windows.md b/docs/versioned_docs/version-0.0.x/features/multi-windows.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/features/multi-windows.md rename to docs/versioned_docs/version-0.0.x/features/multi-windows.md diff --git a/docs/versioned_docs/version-0.x.x/features/navigation.md b/docs/versioned_docs/version-0.0.x/features/navigation.md similarity index 92% rename from docs/versioned_docs/version-0.x.x/features/navigation.md rename to docs/versioned_docs/version-0.0.x/features/navigation.md index 19ff1b4c..faca9c98 100644 --- a/docs/versioned_docs/version-0.x.x/features/navigation.md +++ b/docs/versioned_docs/version-0.0.x/features/navigation.md @@ -19,4 +19,4 @@ And native tabs for MacOS. Demo native tabs -See more about it [here](/docs/0.x.x/navigation). +See more about it [here](/docs/0.0.x/navigation). diff --git a/docs/versioned_docs/version-0.x.x/features/rio-is-fast.md b/docs/versioned_docs/version-0.0.x/features/rio-is-fast.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/features/rio-is-fast.md rename to docs/versioned_docs/version-0.0.x/features/rio-is-fast.md diff --git a/docs/versioned_docs/version-0.x.x/features/spawn-or-fork.md b/docs/versioned_docs/version-0.0.x/features/spawn-or-fork.md similarity index 81% rename from docs/versioned_docs/version-0.x.x/features/spawn-or-fork.md rename to docs/versioned_docs/version-0.0.x/features/spawn-or-fork.md index 2679bbcb..d35f26dd 100644 --- a/docs/versioned_docs/version-0.x.x/features/spawn-or-fork.md +++ b/docs/versioned_docs/version-0.0.x/features/spawn-or-fork.md @@ -7,4 +7,4 @@ In POSIX-based systems, Rio spawn processes instead of forking due to some compa However you can also switch from spawn to fork, forking a process is faster than spawning a process. -See how to configure it in the advanced section [here](/docs/0.x.x/configuration-file). +See how to configure it in the advanced section [here](/docs/0.0.x/configuration-file). diff --git a/docs/versioned_docs/version-0.x.x/features/vi-mode.md b/docs/versioned_docs/version-0.0.x/features/vi-mode.md similarity index 98% rename from docs/versioned_docs/version-0.x.x/features/vi-mode.md rename to docs/versioned_docs/version-0.0.x/features/vi-mode.md index aeeee5d8..84f46453 100644 --- a/docs/versioned_docs/version-0.x.x/features/vi-mode.md +++ b/docs/versioned_docs/version-0.0.x/features/vi-mode.md @@ -9,7 +9,7 @@ By default you can launch Vi mode by using `alt` + `shift` + `space`. ![Demo Vi mode](/assets/features/demo-vi-mode.gif) -Below you can see the list of all default key bindings related to Vi mode. If you don't like of any specified key binding you can always turn off or modify (check [key bindings documentation section](/docs/0.x.x/key-bindings) for more information). +Below you can see the list of all default key bindings related to Vi mode. If you don't like of any specified key binding you can always turn off or modify (check [key bindings documentation section](/docs/0.0.x/key-bindings) for more information). | Trigger | Action | Condition | | :------------------------ | :------------------------- | :------------------- | diff --git a/docs/versioned_docs/version-0.x.x/frequently-asked-questions/index.md b/docs/versioned_docs/version-0.0.x/frequently-asked-questions/index.md similarity index 97% rename from docs/versioned_docs/version-0.x.x/frequently-asked-questions/index.md rename to docs/versioned_docs/version-0.0.x/frequently-asked-questions/index.md index f6c31eb4..0f7988c1 100644 --- a/docs/versioned_docs/version-0.x.x/frequently-asked-questions/index.md +++ b/docs/versioned_docs/version-0.0.x/frequently-asked-questions/index.md @@ -7,7 +7,7 @@ language: 'en' The famous case of "'rio' unknown terminal type". -All the issues all have the same root cause: the rio terminfo is not available. The most common way this happens is SSHing into a computer that does not have the rio terminfo files. The simplest fix would be install the terminfo files on the remote machine (following terminfo instruction in install section [install/terminfo](/docs/0.x.x/install/terminfo)) +All the issues all have the same root cause: the rio terminfo is not available. The most common way this happens is SSHing into a computer that does not have the rio terminfo files. The simplest fix would be install the terminfo files on the remote machine (following terminfo instruction in install section [install/terminfo](/docs/0.0.x/install/terminfo)) Other alternative is use a different terminfo either in config or per connection with environment variable like `TERM=xterm-256color ssh`. diff --git a/docs/versioned_docs/version-0.x.x/install/build-from-source.md b/docs/versioned_docs/version-0.0.x/install/build-from-source.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/install/build-from-source.md rename to docs/versioned_docs/version-0.0.x/install/build-from-source.md diff --git a/docs/versioned_docs/version-0.x.x/install/freebsd.md b/docs/versioned_docs/version-0.0.x/install/freebsd.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/install/freebsd.md rename to docs/versioned_docs/version-0.0.x/install/freebsd.md diff --git a/docs/versioned_docs/version-0.x.x/install/index.md b/docs/versioned_docs/version-0.0.x/install/index.md similarity index 61% rename from docs/versioned_docs/version-0.x.x/install/index.md rename to docs/versioned_docs/version-0.0.x/install/index.md index f0b89d00..a84ce716 100644 --- a/docs/versioned_docs/version-0.x.x/install/index.md +++ b/docs/versioned_docs/version-0.0.x/install/index.md @@ -5,11 +5,11 @@ language: 'en' Rio is available for: -- [MacOS](/docs/0.x.x/install/macos) -- [Linux](/docs/0.x.x/install/linux) -- [Windows](/docs/0.x.x/install/windows) -- [FreeBSD](/docs/0.x.x/install/freebsd) -- [WebAssembly](/docs/0.x.x/install/webassembly) +- [MacOS](/docs/0.0.x/install/macos) +- [Linux](/docs/0.0.x/install/linux) +- [Windows](/docs/0.0.x/install/windows) +- [FreeBSD](/docs/0.0.x/install/freebsd) +- [WebAssembly](/docs/0.0.x/install/webassembly) Rio has two type of builds: stable and nightly. diff --git a/docs/versioned_docs/version-0.x.x/install/linux.md b/docs/versioned_docs/version-0.0.x/install/linux.md similarity index 91% rename from docs/versioned_docs/version-0.x.x/install/linux.md rename to docs/versioned_docs/version-0.0.x/install/linux.md index c580a8b7..2b91d3d3 100644 --- a/docs/versioned_docs/version-0.x.x/install/linux.md +++ b/docs/versioned_docs/version-0.0.x/install/linux.md @@ -11,4 +11,4 @@ Installation options: - openSUSE package: [openSUSE:Factory/rioterm](https://software.opensuse.org/package/rioterm) - Void Linux package: https://github.com/void-linux/void-packages/tree/master/srcpkgs/rio -In case your distro doesn't have the package manager option listed above, proceed to [build from the source](/docs/0.x.x/install/build-from-source). +In case your distro doesn't have the package manager option listed above, proceed to [build from the source](/docs/0.0.x/install/build-from-source). diff --git a/docs/versioned_docs/version-0.x.x/install/macos.md b/docs/versioned_docs/version-0.0.x/install/macos.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/install/macos.md rename to docs/versioned_docs/version-0.0.x/install/macos.md diff --git a/docs/versioned_docs/version-0.x.x/install/terminfo.md b/docs/versioned_docs/version-0.0.x/install/terminfo.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/install/terminfo.md rename to docs/versioned_docs/version-0.0.x/install/terminfo.md diff --git a/docs/versioned_docs/version-0.x.x/install/using-cargo.md b/docs/versioned_docs/version-0.0.x/install/using-cargo.md similarity index 88% rename from docs/versioned_docs/version-0.x.x/install/using-cargo.md rename to docs/versioned_docs/version-0.0.x/install/using-cargo.md index 4f7939d6..3e53af1f 100644 --- a/docs/versioned_docs/version-0.x.x/install/using-cargo.md +++ b/docs/versioned_docs/version-0.0.x/install/using-cargo.md @@ -9,7 +9,7 @@ Cargo is available for most platforms, and is a good alternative to building Rio 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/0.x.x/install/build-from-source) for more information. +You might need to install additional packages depending on your platform. See the guide to [building from source](/docs/0.0.x/install/build-from-source) for more information. ```sh cargo install rioterm diff --git a/docs/versioned_docs/version-0.x.x/install/webassembly.md b/docs/versioned_docs/version-0.0.x/install/webassembly.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/install/webassembly.md rename to docs/versioned_docs/version-0.0.x/install/webassembly.md diff --git a/docs/versioned_docs/version-0.x.x/install/windows.md b/docs/versioned_docs/version-0.0.x/install/windows.md similarity index 96% rename from docs/versioned_docs/version-0.x.x/install/windows.md rename to docs/versioned_docs/version-0.0.x/install/windows.md index bb876766..34fa3d84 100644 --- a/docs/versioned_docs/version-0.x.x/install/windows.md +++ b/docs/versioned_docs/version-0.0.x/install/windows.md @@ -20,7 +20,7 @@ There's a few things to note about the installer and the portable version: - The browser will ask if you want to keep the file, click "Keep" to save the installer/executable on your computer. - When opening the file, Windows will give you a warning, click "More info" and then "Run anyway" to run the installer/executable. -If you want to change the default shell to the new PowerShell platform, change the following line in your config file (see [Configuration file](/docs/0.x.x/configuration-file) for more information): +If you want to change the default shell to the new PowerShell platform, change the following line in your config file (see [Configuration file](/docs/0.0.x/configuration-file) for more information): ```toml shell = { program = "pwsh", args = ["--login"] } diff --git a/docs/versioned_docs/version-0.x.x/key-bindings.md b/docs/versioned_docs/version-0.0.x/key-bindings.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/key-bindings.md rename to docs/versioned_docs/version-0.0.x/key-bindings.md diff --git a/docs/versioned_docs/version-0.x.x/navigation.md b/docs/versioned_docs/version-0.0.x/navigation.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/navigation.md rename to docs/versioned_docs/version-0.0.x/navigation.md diff --git a/docs/versioned_docs/version-0.x.x/plugins.md b/docs/versioned_docs/version-0.0.x/plugins.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/plugins.md rename to docs/versioned_docs/version-0.0.x/plugins.md diff --git a/docs/versioned_docs/version-0.x.x/themes.md b/docs/versioned_docs/version-0.0.x/themes.md similarity index 100% rename from docs/versioned_docs/version-0.x.x/themes.md rename to docs/versioned_docs/version-0.0.x/themes.md diff --git a/docs/versioned_docs/version-0.x.x/features/index.md b/docs/versioned_docs/version-0.x.x/features/index.md deleted file mode 100644 index efa8e830..00000000 --- a/docs/versioned_docs/version-0.x.x/features/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 'Features' -language: 'en' ---- - -Rio is available for Microsoft Windows, Linux distros, FreeBSD and Apple MacOS. - -Short introduction of Rio terminal features. - -- [Vi mode](/docs/0.x.x/features/vi-mode) -- [Hyperlinks](/docs/0.x.x/features/hyperlinks) -- [Kitty keyboard protocol](/docs/0.x.x/features/kitty-keyboard-protocol) -- [Rio is fast](/docs/0.x.x/features/rio-is-fast) -- [Adaptive theme](/docs/0.x.x/features/adaptive-theme) -- [Multi windows](/docs/0.x.x/features/multi-windows) -- [Navigation](/docs/0.x.x/features/navigation) -- [Color automation for navigation](/docs/0.x.x/features/color-automation-for-navigation) -- [Spawn or Fork](/docs/0.x.x/features/spawn-or-fork) - -Note: Many other features are in development. diff --git a/docs/versioned_sidebars/version-0.x.x-sidebars.json b/docs/versioned_sidebars/version-0.0.x-sidebars.json similarity index 100% rename from docs/versioned_sidebars/version-0.x.x-sidebars.json rename to docs/versioned_sidebars/version-0.0.x-sidebars.json diff --git a/docs/versions.json b/docs/versions.json index a5a26995..88c386ed 100644 --- a/docs/versions.json +++ b/docs/versions.json @@ -1,3 +1,3 @@ [ - "0.x.x" + "0.0.x" ] \ No newline at end of file diff --git a/rustfmt.toml b/rustfmt.toml index 8f5ee96e..3f794f78 100644 --- a/rustfmt.toml +++ b/rustfmt.toml @@ -1,5 +1,4 @@ max_width = 90 -newline_style = "Unix" tab_spaces = 4 hard_tabs = false use_small_heuristics = "Default" -- 2.51.2