From b4bf1d17d0e9d73bc591e427f03c89574f3c9031 Mon Sep 17 00:00:00 2001 From: Pavel Sviderski Date: Wed, 28 May 2025 11:14:27 +1000 Subject: [PATCH] docs: add note for Windows installation, enable tabs support --- docs/docs/2-getting-started/1-installation.md | 38 ++++++++++++++++--- docs/src/theme/MDXComponents.js | 13 +++++++ 2 files changed, 45 insertions(+), 6 deletions(-) create mode 100644 docs/src/theme/MDXComponents.js diff --git a/docs/docs/2-getting-started/1-installation.md b/docs/docs/2-getting-started/1-installation.md index 847c20a6..db88bea3 100644 --- a/docs/docs/2-getting-started/1-installation.md +++ b/docs/docs/2-getting-started/1-installation.md @@ -3,6 +3,12 @@ Install the Uncloud command-line utility to manage your machines and deploy apps using `uc` commands. You will run `uc` locally so choose the appropriate installation method for your operating system. +:::info NOTE + +Windows is not natively supported yet, but you can install and run `uc` in a +[WSL](https://learn.microsoft.com/en-us/windows/wsl/) terminal by following the instructions for Linux. +::: + ## Homebrew (macOS, Linux) If you have [Homebrew](https://brew.sh/) package manager installed, this is the recommended installation method on macOS @@ -47,12 +53,32 @@ sh install.sh You can manually download and use a pre-built binary from the [latest release](https://github.com/psviderski/uncloud/releases/latest) on GitHub. -Make sure to replace `(macos|linux)` and `(amd64|arm64)` with your OS and architecture. - -```bash -curl -L https://github.com/psviderski/uncloud/releases/latest/download/uncloud_(macos|linux)_(amd64|arm64).tar.gz | tar xz -mv uncloud uc -``` + + + ```bash + curl -L https://github.com/psviderski/uncloud/releases/latest/download/uncloud_macos_arm64.tar.gz | tar xz + mv uncloud uc + ``` + + + ```bash + curl -L https://github.com/psviderski/uncloud/releases/latest/download/uncloud_macos_amd64.tar.gz | tar xz + mv uncloud uc + ``` + + + ```bash + curl -L https://github.com/psviderski/uncloud/releases/latest/download/uncloud_linux_amd64.tar.gz | tar xz + mv uncloud uc + ``` + + + ```bash + curl -L https://github.com/psviderski/uncloud/releases/latest/download/uncloud_linux_arm64.tar.gz | tar xz + mv uncloud uc + ``` + + You can use the `./uc` binary directly from the current directory, or move it to a directory in your system's `PATH` to run it as `uc` from any location. diff --git a/docs/src/theme/MDXComponents.js b/docs/src/theme/MDXComponents.js new file mode 100644 index 00000000..2f514efd --- /dev/null +++ b/docs/src/theme/MDXComponents.js @@ -0,0 +1,13 @@ +import React from 'react'; +// Import the original mapper +import MDXComponents from '@theme-original/MDXComponents'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +export default { + // Re-use the default mapping + ...MDXComponents, + // Global import the and components + Tabs, + TabItem, +};