summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRuben Arts <ruben.arts@hotmail.com>2023-10-03 21:36:54 +0200
committerGitHub <noreply@github.com>2023-10-03 21:36:54 +0200
commitd91069f0944f2199d4b0570f1c4c3797c2cc8608 (patch)
treee5456d9536da6e5bbcf22c4ec98cf714a06b521f
parent8b0532294c655ff01fea6f514454589a0c18a8aa (diff)
fix: footnote and powershell (#377)main
-rw-r--r--docs/cli.mdx9
-rw-r--r--docs/overview.mdx99
2 files changed, 54 insertions, 54 deletions
diff --git a/docs/cli.mdx b/docs/cli.mdx
index 9aa1370..c269a74 100644
--- a/docs/cli.mdx
+++ b/docs/cli.mdx
@@ -330,8 +330,9 @@ pixi project channel add --no-install robostack
```
[^1]: An __up-to-date__ lockfile means that the dependencies in the lockfile are allowed by the dependencies in the manifest file.
- For example
- - a `pixi.toml` with `python = ">= 3.11"` is up-to-date with a `name: python, version: 3.11.0` in the `pixi.lock`.
- - a `pixi.toml` with `python = ">= 3.12"` is **not** up-to-date with a `name: python, version: 3.11.0` in the `pixi.lock`.
+For example
- Being up-to-date does **not** mean that the lockfile holds the latest version available on the channel for the given dependency.
+ - a `pixi.toml` with `python = ">= 3.11"` is up-to-date with a `name: python, version: 3.11.0` in the `pixi.lock`.
+ - a `pixi.toml` with `python = ">= 3.12"` is **not** up-to-date with a `name: python, version: 3.11.0` in the `pixi.lock`.
+
+ Being up-to-date does **not** mean that the lockfile holds the latest version available on the channel for the given dependency.
diff --git a/docs/overview.mdx b/docs/overview.mdx
index f666175..2746b66 100644
--- a/docs/overview.mdx
+++ b/docs/overview.mdx
@@ -5,36 +5,36 @@ description: Package management made easy
---
Pixi is a package management tool for developers.
-It allows the developer to install libraries and applications a reproducible way.
+It allows the developer to install libraries and applications in a reproducible way.
Use pixi cross-platform, on Windows, Mac and Linux.
# Installation
-To install pixi you can run the following command in your terminal:
+To install `pixi` you can run the following command in your terminal:
<Tabs groupId="install_os">
- <TabItem value="Linux & macOS">
- ```bash
- curl -fsSL https://pixi.sh/install.sh | bash
- ```
+ <TabItem value="Linux & macOS">
+ ```bash
+ curl -fsSL https://pixi.sh/install.sh | bash
+ ```
- The above invocation will automatically download the latest version of `pixi`, extract it, and move the `pixi` binary to `~/.pixi/bin`.
- If this directory does not already exist, the script will create it.
+ The above invocation will automatically download the latest version of `pixi`, extract it, and move the `pixi` binary to `~/.pixi/bin`.
+ If this directory does not already exist, the script will create it.
- The script will also update your `~/.bash_profile` to include `~/.pixi/bin` in your PATH, allowing you to invoke the `pixi` command from anywhere.
+ The script will also update your `~/.bash_profile` to include `~/.pixi/bin` in your PATH, allowing you to invoke the `pixi` command from anywhere.
- </TabItem>
- <TabItem value="Windows">
- ```shell
- iwr -useb https://pixi.sh/install.ps1 | iex
- ```
+ </TabItem>
+ <TabItem value="Windows">
+ ```shell
+ iwr -useb https://pixi.sh/install.ps1 | iex
+ ```
- The above invocation will automatically download the latest version of `pixi`, extract it, and move the `pixi` binary to `LocalAppData/pixi/bin`.
- If this directory does not already exist, the script will create it.
+ The above invocation will automatically download the latest version of `pixi`, extract it, and move the `pixi` binary to `LocalAppData/pixi/bin`.
+ If this directory does not already exist, the script will create it.
- The command will also automatically add `LocalAppData/pixi/bin` to your path allowing you to invoke `pixi` from anywhere.
+ The command will also automatically add `LocalAppData/pixi/bin` to your path allowing you to invoke `pixi` from anywhere.
- </TabItem>
+ </TabItem>
</Tabs>
:::tip
@@ -58,8 +58,8 @@ To get autocompletion run:
```
</TabItem>
<TabItem value="Windows">
- ```shell
- Add-Content -Path $PROFILE -Value 'Invoke-Expression (&pixi completion --shell powershell)'
+ ```powershell
+ Add-Content -Path $PROFILE -Value '(& pixi completion --shell powershell) | Out-String | Invoke-Expression'
```
</TabItem>
</Tabs>
@@ -85,8 +85,7 @@ The installer will download pixi and add it to the path.
### Install from source
-pixi is 100% written in Rust and therefore it can be installed, build and
-tested with cargo.
+pixi is 100% written in Rust, and therefore it can be installed, build and tested with cargo.
To start using pixi from a source build run:
```shell
@@ -105,39 +104,39 @@ it's [compile steps](https://github.com/mamba-org/rattler/tree/main#give-it-a-tr
## Uninstall
-To uninstall pixi from you system, simply remove the binary.
+To uninstall pixi from your system, simply remove the binary.
<Tabs groupId="install_os">
- <TabItem value="Linux & macOS">
- ```shell
- rm ~/.pixi/bin/pixi
- ```
- </TabItem>
- <TabItem value="Windows">
- ```shell
- $PIXI_BIN = "$Env:LocalAppData\pixi\bin\pixi"; Remove-Item -Path $PIXI_BIN
- ```
- </TabItem>
+ <TabItem value="Linux & macOS">
+ ```shell
+ rm ~/.pixi/bin/pixi
+ ```
+ </TabItem>
+ <TabItem value="Windows">
+ ```shell
+ $PIXI_BIN = "$Env:LocalAppData\pixi\bin\pixi"; Remove-Item -Path $PIXI_BIN
+ ```
+ </TabItem>
</Tabs>
-After this command you can still use the tools you installed with pixi.
-To remove these as well just remove the whole `~/.pixi` directory and remove the directory from your path.
+After this command, you can still use the tools you installed with pixi.
+To remove these as well, just remove the whole `~/.pixi` directory and remove the directory from your path.
<Cols3>
- <DocLinkCard
- link="/pixi/basic_usage"
- title="Basic usage"
- excerpt="Learn how to use pixi."
- ></DocLinkCard>
- <DocLinkCard
- link="/pixi/cli"
- title="Command reference"
- excerpt="Explains all available pixi subcommands."
- ></DocLinkCard>
- <DocLinkCard
- link="/pixi/examples"
- title="Example projects"
- excerpt="See a few examples of projects run with pixi."
- ></DocLinkCard>
+ <DocLinkCard
+ link="/pixi/basic_usage"
+ title="Basic usage"
+ excerpt="Learn how to use pixi."
+ ></DocLinkCard>
+ <DocLinkCard
+ link="/pixi/cli"
+ title="Command reference"
+ excerpt="Explains all available pixi subcommands."
+ ></DocLinkCard>
+ <DocLinkCard
+ link="/pixi/examples"
+ title="Example projects"
+ excerpt="See a few examples of projects run with pixi."
+ ></DocLinkCard>
</Cols3>