From c041166aeec44ffaccb495983266bbcbc5cb5a15 Mon Sep 17 00:00:00 2001 From: Kenneth Bingham Date: Wed, 22 Nov 2023 23:21:28 -0500 Subject: [PATCH] number install steps --- docs/guides/install/linux.mdx | 15 +++++++++- docs/guides/install/macos.mdx | 50 ++++++++++++++++----------------- docs/guides/install/windows.mdx | 50 ++++++++++++++++----------------- 3 files changed, 64 insertions(+), 51 deletions(-) diff --git a/docs/guides/install/linux.mdx b/docs/guides/install/linux.mdx index 881cd4fd..d6ad6624 100644 --- a/docs/guides/install/linux.mdx +++ b/docs/guides/install/linux.mdx @@ -3,7 +3,20 @@ title: Install zrok in Linux sidebar_label: Linux --- -import Details from '@theme/MDXComponents/Details'; +import { AssetsProvider } from '@site/src/components/assets-context'; +import DownloadCard from '@site/src/components/download-card'; +import styles from '@site/src/css/download-card.module.css'; + +## Extract Distribution + + +
+ +
+
## Install Linux Package diff --git a/docs/guides/install/macos.mdx b/docs/guides/install/macos.mdx index b183f8d8..92b7d315 100644 --- a/docs/guides/install/macos.mdx +++ b/docs/guides/install/macos.mdx @@ -20,36 +20,36 @@ import styles from '@site/src/css/download-card.module.css'; Download the binary distribution for your macOS architecture. For Intel Macs use the `amd64` distribution. For Apple Silicon Macs use the `arm64` distribution. -Unarchive the distribution in a temporary directory: +1. Unarchive the distribution in a temporary directory. -```text -mkdir /tmp/zrok && tar -xf ./zrok*darwin*.tar.gz -C /tmp/zrok -``` + ```text + mkdir /tmp/zrok && tar -xf ./zrok*darwin*.tar.gz -C /tmp/zrok + ``` -Install the `zrok` executable. +1. Install the `zrok` executable. -```text -mkdir -p ~/bin && install /tmp/zrok/zrok ~/bin/ -``` + ```text + mkdir -p ~/bin && install /tmp/zrok/zrok ~/bin/ + ``` -Add `~/bin` to your shell's executable search path. Optionally add this to your ~/.zshenv to persist the change. +1. Add `~/bin` to your shell's executable search path. Optionally add this to your ~/.zshenv to persist the change. -```text -export PATH=~/bin:$PATH -``` + ```text + export PATH=~/bin:$PATH + ``` -With the `zrok` executable in your path, you can then execute the `zrok` command from your shell: +1. With the `zrok` executable in your path, you can then execute the `zrok` command from your shell: -```text -zrok version -``` + ```text + zrok version + ``` -```buttonless title="Output" - _ - _____ __ ___ | | __ -|_ / '__/ _ \| |/ / - / /| | | (_) | < -/___|_| \___/|_|\_\ - -v0.4.0 [c889005] -``` + ```buttonless title="Output" + _ + _____ __ ___ | | __ + |_ / '__/ _ \| |/ / + / /| | | (_) | < + /___|_| \___/|_|\_\ + + v0.4.0 [c889005] + ``` diff --git a/docs/guides/install/windows.mdx b/docs/guides/install/windows.mdx index 08c853d6..dd3a3d8d 100644 --- a/docs/guides/install/windows.mdx +++ b/docs/guides/install/windows.mdx @@ -18,35 +18,35 @@ import styles from '@site/src/css/download-card.module.css'; -Unarchive the distribution in a temporary directory: +1. Unarchive the distribution in a temporary directory: -```text -New-Item -Path "$env:TEMP\zrok" -ItemType Directory -ErrorAction Stop -tar -xf .\zrok*windows*.tar.gz -C "$env:TEMP\zrok" -``` + ```text + New-Item -Path "$env:TEMP\zrok" -ItemType Directory -ErrorAction Stop + tar -xf .\zrok*windows*.tar.gz -C "$env:TEMP\zrok" + ``` -Install the `zrok` executable and include HOME\bin in the search PATH. +1. Install the `zrok` executable and include HOME\bin in the search PATH. -```text -$source = Join-Path -Path $env:TEMP -ChildPath "zrok\zrok.exe" -$destination = Join-Path -Path $env:HOME -ChildPath "bin\zrok.exe" -New-Item -Path $destination -ItemType Directory -ErrorAction SilentlyContinue -Copy-Item -Path $source -Destination $destination -$env:path += ";"+$destination -``` + ```text + $source = Join-Path -Path $env:TEMP -ChildPath "zrok\zrok.exe" + $destination = Join-Path -Path $env:HOME -ChildPath "bin\zrok.exe" + New-Item -Path $destination -ItemType Directory -ErrorAction SilentlyContinue + Copy-Item -Path $source -Destination $destination + $env:path += ";"+$destination + ``` -With the `zrok` executable in your path, you can then execute the `zrok` directly. +1. With the `zrok` executable in your path, you can then execute the `zrok` directly. -```text -zrok version -``` + ```text + zrok version + ``` -```buttonless title="Output" - _ - _____ __ ___ | | __ -|_ / '__/ _ \| |/ / - / /| | | (_) | < -/___|_| \___/|_|\_\ + ```buttonless title="Output" -v0.4.0 [c889005] -``` + _____ __ ___ | | __ + |_ / '__/ _ \| |/ / + / /| | | (_) | < + /___|_| \___/|_|\_\ + + v0.4.0 [c889005] + ```