docs: add wsl executable info

This commit is contained in:
Jan De Dobbeleer 2021-09-01 13:45:33 +02:00 committed by Jan De Dobbeleer
parent 7386b55b6e
commit 8e64f29d07
10 changed files with 14 additions and 10 deletions

View file

@ -37,7 +37,7 @@ To set this configuration in combination with a Oh My Posh [executable][releases
set a path to a JSON file containing the above code. The `--shell universal` flag is used to print the prompt without
escape characters to see the prompt as it would be shown inside a prompt function for your shell.
:::info
:::caution
The command below will not persist the configuration for your shell but print the prompt in your terminal.
If you want to use your own configuration permanently, adjust the prompt configuration to use your custom
theme.

View file

@ -56,7 +56,7 @@ Exiting that file will start the rebase and spwan your `$EDITOR` to alter the co
Once done, use `git push --force` to bring the changes to the pull request.
:::info vscode
:::tip vscode
The latest version of vscode has a built-in gui to help you select `reword` or any other action on a commit. Select the right ones and press
Start Rebase to continue.
:::

View file

@ -11,7 +11,7 @@ sidebar_label: Get Started
The codebase is in [go][go], meaning we need a working go setup before we can do anything else.
Have a look at the [go guide][go-started] to get up and running with go in no time!
:::info
:::caution
Oh My Posh needs at least go 1.17.
:::

View file

@ -1,7 +1,7 @@
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
:::info
:::tip
If you have no idea which shell you're currently using, Oh My Posh has a utility switch that can tell that to you (not relevant
for the Powershell module).
:::

View file

@ -179,13 +179,17 @@ Based on the installation method used, you can find this theme at the following
</TabItem>
</Tabs>
:::caution
When using oh-my-posh inside the WSL, make sure to use the `oh-my-posh-wsl` executable instead.
:::
<Shells />
### Customize
<Customize />
:::info
:::tip
When using oh-my-posh in Windows and the WSL, know that you can share your theme with the WSL by pointing to a theme in your
Windows user's home folder.

View file

@ -8,7 +8,7 @@ sidebar_label: Azure
Display the currently active Azure subscription information.
:::info
:::caution
PowerShell offers support for the `Az.Accounts` module, but it is disabled by default.
To enable this, set `$env:AZ_ENABLED = $true` in your `$PROFILE`.
:::

View file

@ -6,7 +6,7 @@ sidebar_label: Command
## What
:::info Powershell
:::caution Powershell
While powerful, it tends to take a lot of time executing the command on **Powershell**.
Even with `noprofile` it's noticeably slower compared to `sh`. It's advised to look at using
[environment variables][env] when using Powershell.

View file

@ -16,7 +16,7 @@ Local changes can also be displayed which uses the following syntax for both the
- `-` deleted
- `?` untracked
:::info
:::tip
PowerShell offers support for the `posh-git` module for autocompletion, but it is disabled by default.
To enable this, set `$env:POSH_GIT_ENABLED = $true` in your `$PROFILE`.
:::

View file

@ -8,7 +8,7 @@ sidebar_label: Git (posh-git)
Display the [posh-git][posh-git] prompt.
:::info
:::caution
This segment only works within Powershell and requires the posh-git module to be installed and imported.
To enable the `posh-git` module, set `$env:POSH_GIT_ENABLED = $true` in your `$PROFILE`.
:::

View file

@ -8,7 +8,7 @@ sidebar_label: Terraform
Display the currently active Terraform Workspace name.
:::info
:::caution
This requires a terraform binary in your PATH and will only show in directories that contain a `.terraform` subdirectory
:::