diff --git a/docs/.markdownlint.json b/docs/.markdownlint.json index 2e3bb50de..78cadf910 100644 --- a/docs/.markdownlint.json +++ b/docs/.markdownlint.json @@ -9,7 +9,8 @@ "img", "div", "Tabs", - "TabItem" + "TabItem", + "CodeBlock" ] }, } diff --git a/docs/docs/setup/download.md b/docs/docs/setup/download.md index 9b497b29a..d7cf75fd2 100644 --- a/docs/docs/setup/download.md +++ b/docs/docs/setup/download.md @@ -1,5 +1,10 @@ # Downloads +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import {Version} from '@site/src/corsoEnv'; + Corso is available as a Docker container image or as native binaries. ## Docker container images @@ -13,7 +18,82 @@ We strongly recommend using a container image with the release version tag (for `ghcr.io/alcionai/corso:v0.1.0`) but container images with the `latest` tag are also available. Unreleased builds with the `nightly` tag are also provided for testing but these are likely to be unstable. + + + + { + `docker pull ghcr.io/alcionai/corso:${Version()}` + } + + + + + ```bash + docker pull ghcr.io/alcionai/corso:latest + ``` + + + + + ```bash + docker pull ghcr.io/alcionai/corso:nightly + ``` + + + + ## Native binaries Corso is also available as an `x86_64` and `arm64` executable for Windows, Linux and macOS. These can be downloaded from the [GitHub releases page](https://github.com/alcionai/corso/releases). + + + + + + + +{ +`Invoke-WebRequest \` + -Uri https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Windows_x86_64.tar.gz \` + -UseBasicParsing -Outfile corso_${Version()}_Windows_x86_64.tar.gz +tar zxvf .\\corso_${Version()}_Windows_x86_64.tar.gz` +} + + + + +{ +`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Linux_arm64.tar.gz && \\ + tar zxvf corso_${Version()}_Linux_arm.tar.gz` +} + + + + +{ +`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Linux_x86_64.tar.gz && \\ + tar zxvf corso_${Version()}_Linux_x86_64.tar.gz` +} + + + + +{ +`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Darwin_arm64.tar.gz && \\ + tar zxvf corso_${Version()}_Darwin_arm.tar.gz` +} + + + + +{ +`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Darwin_x86_64.tar.gz && \\ + tar zxvf corso_${Version()}_Darwin_x86_64.tar.gz` +} + + + + + + diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 15cf887c7..7ffcf2d8f 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -33,6 +33,10 @@ const config = { require.resolve('docusaurus-plugin-image-zoom') ], + customFields: { + corsoVersion: `${process.env.CORSO_VERSION}`, + }, + presets: [ [ 'classic', diff --git a/docs/src/corsoEnv.js b/docs/src/corsoEnv.js new file mode 100644 index 000000000..99988a2cb --- /dev/null +++ b/docs/src/corsoEnv.js @@ -0,0 +1,7 @@ +import React from 'react'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; + +export const Version = () => { + const {siteConfig} = useDocusaurusContext(); + return siteConfig.customFields.corsoVersion; +}