From 57f0eecf39144f555bae0e942fcdd7ef16154f35 Mon Sep 17 00:00:00 2001 From: Jan De Dobbeleer Date: Wed, 17 Jul 2024 08:44:48 +0200 Subject: [PATCH] docs(customize): start with shell specific config syntax --- website/docs/installation/customize.mdx | 78 ++++++++++++------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/website/docs/installation/customize.mdx b/website/docs/installation/customize.mdx index 2d0c6ca21723..67621feb24a1 100644 --- a/website/docs/installation/customize.mdx +++ b/website/docs/installation/customize.mdx @@ -19,53 +19,19 @@ There are two possible values the `--config` flag can handle: - a path to a local configuration file ```powershell -oh-my-posh init pwsh --config 'C:/Users/Posh/jandedobbeleer.omp.json' | Invoke-Expression +--config 'C:/Users/Posh/jandedobbeleer.omp.json' ``` - a URL pointing to a remote config ```powershell -oh-my-posh init pwsh --config 'https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/jandedobbeleer.omp.json' | Invoke-Expression +--config 'https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/jandedobbeleer.omp.json' ``` -### Get inspiration - -The Windows and homebrew installers also bundle the **predefined configurations** ([themes][themes]). You can use the -following way to reference them directly. This will keep them up-to-date and compatible with future updates. - - - - -For example, to use the [jandedobbeleer][jandedobbeleer] theme, alter the init line like this (`powershell`): - -```powershell -oh-my-posh init pwsh --config "$env:POSH_THEMES_PATH/jandedobbeleer.omp.json" | Invoke-Expression -``` - - - - -When using homebrew, all themes are installed alongside Oh My Posh in `$(brew --prefix oh-my-posh)/themes`. -To use any of the themes, use the following syntax (`zsh`): - -```bash -eval "$(oh-my-posh init zsh --config $(brew --prefix oh-my-posh)/themes/jandedobbeleer.omp.json)" -``` - - - - -### Config syntax +### Shell syntax -The examples below use a local path to the [jandedobbeleer][jandedobbeleer] theme, adjust the `--config` value -to reflect your use-case. +The example below use a local path to the [jandedobbeleer][jandedobbeleer] theme, adjust the `--config` value +to reflect your configuration file, local or remote. `. ::: +### Get inspiration + +The Windows and homebrew installers also bundle the **predefined configurations** ([themes][themes]). You can use the +following way to reference them directly. This will keep them up-to-date and compatible with future updates. + + + + +For example, to use the [jandedobbeleer][jandedobbeleer] theme, alter the init line like this (`powershell`): + +```powershell +oh-my-posh init pwsh --config "$env:POSH_THEMES_PATH/jandedobbeleer.omp.json" | Invoke-Expression +``` + + + + +When using homebrew, all themes are installed alongside Oh My Posh in `$(brew --prefix oh-my-posh)/themes`. +To use any of the themes, use the following syntax (`zsh`): + +```bash +eval "$(oh-my-posh init zsh --config $(brew --prefix oh-my-posh)/themes/jandedobbeleer.omp.json)" +``` + + + + ### Adjust a theme Maybe there's a theme you like, but you don't fancy the colors. Or, maybe there's a segment you