mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2024-12-26 19:39:39 -08:00
docs: move sections into folders
This commit is contained in:
Jan De Dobbeleer
Jan De Dobbeleer
parent
5553900140
commit
a55f94d4cd
|
|
@ -141,8 +141,8 @@ _Keep that prompt posh everyone! _
|
|||
|
||||
[blog-1]: /blog/whats-new-1
|
||||
[fish]: https://fishshell.com/
|
||||
[right]: /docs/config-block#type
|
||||
[transient]: /docs/config-transient
|
||||
[tooltips]: /docs/config-tooltips
|
||||
[color-templates]: /docs/config-colors#color-templates
|
||||
[right]: /docs/configuration/block#type
|
||||
[transient]: /docs/configuration/transient
|
||||
[tooltips]: /docs/configuration/tooltips
|
||||
[color-templates]: /docs/configuration/colors#color-templates
|
||||
[go1.18]: https://tip.golang.org/doc/go1.18
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-block
|
||||
id: block
|
||||
title: Block
|
||||
sidebar_label: Block
|
||||
---
|
||||
|
|
@ -59,4 +59,4 @@ to be repeated to this property. Add this property to the _right_ aligned block.
|
|||
|
||||
Array of one or more segments.
|
||||
|
||||
[color-overrides]: /docs/config-colors#color-overrides
|
||||
[color-overrides]: /docs/configuration/colors#color-overrides
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-colors
|
||||
id: colors
|
||||
title: Colors
|
||||
sidebar_label: Colors
|
||||
---
|
||||
|
|
@ -190,7 +190,7 @@ For example, `p:foreground` and `p:background` will be correctly set to "#CAF0F8
|
|||
|
||||
[hexcolors]: https://htmlcolorcodes.com/color-chart/material-design-color-chart/
|
||||
[ansicolors]: https://htmlcolorcodes.com/color-chart/material-design-color-chart/
|
||||
[git]: /docs/segment-git
|
||||
[battery]: /docs/segment-battery
|
||||
[template-properties]: /docs/config-templates#global-properties
|
||||
[git]: /docs/segments/git
|
||||
[battery]: /docs/segments/battery
|
||||
[template-properties]: /docs/configuration/templates#global-properties
|
||||
[aws]: /docs/aws
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-debug-prompt
|
||||
id: debug-prompt
|
||||
title: Debug prompt
|
||||
sidebar_label: Debug prompt
|
||||
---
|
||||
|
|
@ -53,7 +53,7 @@ properties below - defaults to `[DBG]: `
|
|||
|
||||
[go-text-template]: https://golang.org/pkg/text/template/
|
||||
[sprig]: https://masterminds.github.io/sprig/
|
||||
[console-title]: /docs/config-title#console-title-template
|
||||
[templates]: /docs/config-templates
|
||||
[colors]: /docs/config-colors
|
||||
[color-templates]: /docs/config-colors#color-templates
|
||||
[console-title]: /docs/configuration/title#console-title-template
|
||||
[templates]: /docs/configuration/templates
|
||||
[colors]: /docs/configuration/colors
|
||||
[color-templates]: /docs/configuration/colors#color-templates
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-sample
|
||||
id: sample
|
||||
title: Sample
|
||||
sidebar_label: Sample
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-fonts
|
||||
id: fonts
|
||||
title: Fonts
|
||||
sidebar_label: Fonts
|
||||
---
|
||||
|
|
@ -47,4 +47,4 @@ The `minimal` themes do not make use of Nerd Font icons.
|
|||
[meslo]: https://github.com/ryanoasis/nerd-fonts/releases/download/v2.1.0/Meslo.zip
|
||||
[themes]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/themes
|
||||
[font-thread]: https://github.com/JanDeDobbeleer/oh-my-posh/issues/145#issuecomment-730162622
|
||||
[configuration]: /docs/config-overview
|
||||
[configuration]: /docs/configuration/overview
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-line-error
|
||||
id: line-error
|
||||
title: Line error
|
||||
sidebar_label: Line error
|
||||
---
|
||||
|
|
@ -81,6 +81,6 @@ Restart your shell or reload your `$PROFILE` using `. $PROFILE` for the changes
|
|||
|
||||
[go-text-template]: https://golang.org/pkg/text/template/
|
||||
[sprig]: https://masterminds.github.io/sprig/
|
||||
[console-title]: /docs/config-title#console-title-template
|
||||
[console-title]: /docs/configuration/title#console-title-template
|
||||
[psreadline]: https://github.com/PowerShell/PSReadLine
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-overview
|
||||
id: overview
|
||||
title: General
|
||||
sidebar_label: General
|
||||
---
|
||||
|
|
@ -71,6 +71,6 @@ For example, the following is a valid `--config` flag:
|
|||
you notice black elements in Windows Terminal or the Visual Studio Code integrated terminal
|
||||
|
||||
[releases]: https://github.com/JanDeDobbeleer/oh-my-posh/releases/latest
|
||||
[font]: /docs/config-fonts
|
||||
[font]: /docs/configuration/fonts
|
||||
[schema]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/schema.json
|
||||
[themes]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/themes
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-secondary-prompt
|
||||
id: secondary-prompt
|
||||
title: Secondary prompt
|
||||
sidebar_label: Secondary prompt
|
||||
---
|
||||
|
|
@ -47,6 +47,6 @@ properties below - defaults to `> `
|
|||
|
||||
[go-text-template]: https://golang.org/pkg/text/template/
|
||||
[sprig]: https://masterminds.github.io/sprig/
|
||||
[console-title]: /docs/config-title#console-title-template
|
||||
[templates]: /docs/config-templates
|
||||
[colors]: /docs/config-colors
|
||||
[console-title]: /docs/configuration/title#console-title-template
|
||||
[templates]: /docs/configuration/templates
|
||||
[colors]: /docs/configuration/colors
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-segment
|
||||
id: segment
|
||||
title: Segment
|
||||
sidebar_label: Segment
|
||||
---
|
||||
|
|
@ -160,9 +160,9 @@ This means that for user Bill, who has a user account `Bill` on Windows and `bil
|
|||
`C:\Users\Bill\Foo` or `C:\Users\Bill\foo` on Windows but only `/home/bill/Foo` on Linux.
|
||||
|
||||
[segments]: /docs/battery
|
||||
[colors]: /docs/config-colors
|
||||
[colors]: /docs/configuration/colors
|
||||
[go-text-template]: https://golang.org/pkg/text/template/
|
||||
[sprig]: https://masterminds.github.io/sprig/
|
||||
[regex]: https://www.regular-expressions.info/tutorial.html
|
||||
[templates]: /docs/config-templates
|
||||
[color-templates]: /docs/config-colors#color-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[color-templates]: /docs/configuration/colors#color-templates
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-templates
|
||||
id: templates
|
||||
title: Templates
|
||||
sidebar_label: Templates
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-title
|
||||
id: title
|
||||
title: Console title
|
||||
sidebar_label: Console title
|
||||
---
|
||||
|
|
@ -36,4 +36,4 @@ To learn more about templates and their possibilities, have a look at the [templ
|
|||
|
||||
[go-text-template]: https://golang.org/pkg/text/template/
|
||||
[sprig]: https://masterminds.github.io/sprig/
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-tooltips
|
||||
id: tooltips
|
||||
title: Tooltips
|
||||
sidebar_label: Tooltips
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: config-transient
|
||||
id: transient
|
||||
title: Transient prompt
|
||||
sidebar_label: Transient prompt
|
||||
---
|
||||
|
|
@ -133,10 +133,10 @@ Restart your shell or reload fish using `exec fish` for the changes to take effe
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
[colors]: /docs/config-colors
|
||||
[colors]: /docs/configuration/colors
|
||||
[go-text-template]: https://golang.org/pkg/text/template/
|
||||
[console-title]: /docs/config-title#console-title-template
|
||||
[console-title]: /docs/configuration/title#console-title-template
|
||||
[sprig]: https://masterminds.github.io/sprig/
|
||||
[clink]: https://chrisant996.github.io/clink/
|
||||
[templates]: /docs/config-templates
|
||||
[color-templates]: /docs/config-colors#color-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[color-templates]: /docs/configuration/colors#color-templates
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: contributing_git
|
||||
id: git
|
||||
title: Git commands for contributors
|
||||
sidebar_label: Git Commands
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: contributing_plastic
|
||||
id: plastic
|
||||
title: Setup for Plastic SCM testing
|
||||
sidebar_label: Plastic SCM testing
|
||||
---
|
||||
|
|
@ -90,7 +90,7 @@ sudo apt-get install plasticscm-client-core
|
|||
To connect the client to the server and set up an account run:
|
||||
|
||||
```bash
|
||||
clconfigureclient
|
||||
clconfigureclient
|
||||
```
|
||||
|
||||
You are asked a few questions. Choose these options:
|
||||
|
|
@ -167,7 +167,7 @@ Just in case you don't want or can't commit your local changes, there is an undo
|
|||
This will undo all local changes:
|
||||
|
||||
```bash
|
||||
cm status | cm undo .
|
||||
cm status | cm undo .
|
||||
```
|
||||
|
||||
### Changing, moving or deleting files
|
||||
|
|
@ -213,7 +213,7 @@ cm find labels
|
|||
```
|
||||
|
||||
#### Switch your local workspace to a branch
|
||||
|
||||
|
||||
To switch to a branch use
|
||||
|
||||
```bash
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: contributing_segment
|
||||
id: segment
|
||||
title: Add Segment
|
||||
sidebar_label: Add Segment
|
||||
---
|
||||
|
|
@ -85,7 +85,7 @@ go build -o $GOPATH/bin/oh-my-posh
|
|||
|
||||
## Add the documentation
|
||||
|
||||
Create a new `markdown` file underneath the [`docs/docs`][docs] folder called `segment-new.md`.
|
||||
Create a new `markdown` file underneath the [`docs/docs/segments`][docs] folder called `new.md`.
|
||||
Use the following template as a guide.
|
||||
|
||||
````markdown
|
||||
|
|
@ -167,7 +167,7 @@ And be patient, I'm going as fast as I can 🏎
|
|||
|
||||
[segment-go]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/segment.go
|
||||
[themes]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/themes
|
||||
[docs]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/docs/docs
|
||||
[docs]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/docs/docs/segments
|
||||
[sidebars]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/docs/sidebars.js
|
||||
[nf-icons]: https://www.nerdfonts.com/cheat-sheet
|
||||
[tests]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/src/segments/az_test.go
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: contributing_started
|
||||
id: started
|
||||
title: Get Started
|
||||
sidebar_label: Get Started
|
||||
---
|
||||
|
|
@ -199,7 +199,7 @@ $OutputEncoding = [console]::InputEncoding = [console]::OutputEncoding = New-Obj
|
|||
[wt-glyph]: https://github.com/microsoft/terminal/issues/3546
|
||||
[wt-glyphs]: https://github.com/microsoft/terminal/issues?q=is%3Aissue+is%3Aopen+unicode+width
|
||||
[nf]: https://www.nerdfonts.com/
|
||||
[font]: /docs/config-fonts
|
||||
[font]: /docs/configuration/fonts
|
||||
[jb-icons]: https://youtrack.jetbrains.com/issue/IDEA-248010
|
||||
[upgrading]: upgrading.md
|
||||
[wt-vim]: https://github.com/microsoft/terminal/issues/3794
|
||||
|
|
|
|||
|
|
@ -149,6 +149,6 @@ oh-my-posh config export --output ~/.mytheme.omp.json
|
|||
|
||||
|
||||
[themes]: themes.md
|
||||
[configuration]: config-overview.md
|
||||
[configuration]: configuration/overview.md
|
||||
[default-theme]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/default.omp.json
|
||||
[jandedobbeleer]: /docs/themes#jandedobbeleer
|
||||
|
|
@ -6,7 +6,7 @@ sidebar_label: 🐧 Linux
|
|||
|
||||
import Tabs from "@theme/Tabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import InstallHomebrew from "./install-homebrew.mdx";
|
||||
import InstallHomebrew from "./homebrew.mdx";
|
||||
|
||||
## Set up your terminal
|
||||
|
||||
|
|
@ -58,10 +58,10 @@ rm ~/.poshthemes/themes.zip
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
[fonts]: /docs/config-fonts
|
||||
[fonts]: /docs/configuration/fonts
|
||||
[scoop]: https://scoop.sh/
|
||||
[wt]: https://github.com/microsoft/terminal
|
||||
[iterm2]: https://www.iterm2.com/
|
||||
[powershell]: https://www.powershellgallery.com/packages/oh-my-posh
|
||||
[configuration]: /docs/config-overview
|
||||
[configuration]: /docs/configuration/overview
|
||||
[themes]: /docs/themes
|
||||
|
|
@ -6,7 +6,7 @@ sidebar_label: 🍏 macOS
|
|||
|
||||
import Tabs from "@theme/Tabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import InstallHomebrew from "./install-homebrew.mdx";
|
||||
import InstallHomebrew from "./homebrew.mdx";
|
||||
|
||||
## Set up your terminal
|
||||
|
||||
|
|
@ -21,9 +21,9 @@ To display all icons, we recommend the use of a [Nerd Font][fonts].
|
|||
|
||||
<InstallHomebrew />
|
||||
|
||||
[fonts]: /docs/config-fonts
|
||||
[fonts]: /docs/configuration/fonts
|
||||
[scoop]: https://scoop.sh/
|
||||
[wt]: https://github.com/microsoft/terminal
|
||||
[iterm2]: https://www.iterm2.com/
|
||||
[powershell]: https://www.powershellgallery.com/packages/oh-my-posh
|
||||
[configuration]: /docs/config-overview
|
||||
[configuration]: /docs/configuration/overview
|
||||
|
|
@ -150,7 +150,7 @@ exec fish
|
|||
Oh My Posh requires Nushell >= 0.60.0
|
||||
:::
|
||||
|
||||
Edit `$nu.config-path` and add the following lines at the bottom.
|
||||
Edit `$nu.configuration/path` and add the following lines at the bottom.
|
||||
|
||||
```bash
|
||||
oh-my-posh init nu
|
||||
|
|
@ -173,7 +173,7 @@ when setting the prompt using the `--config` flag.
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
[fonts]: /docs/config-fonts
|
||||
[fonts]: /docs/configuration/fonts
|
||||
[scoop]: https://scoop.sh/
|
||||
[wt]: https://github.com/microsoft/terminal
|
||||
[powershell]: https://www.powershellgallery.com/packages/oh-my-posh
|
||||
|
|
@ -48,7 +48,7 @@ installation guide to get started right away!
|
|||
|
||||
[omp]: https://github.com/JanDeDobbeleer/oh-my-posh2
|
||||
[omz]: https://github.com/ohmyzsh/ohmyzsh
|
||||
[block]: /docs/config-overview#block
|
||||
[segment]: /docs/config-overview#segment
|
||||
[block]: /docs/configuration/overview#block
|
||||
[segment]: /docs/configuration/overview#segment
|
||||
[themes]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/themes
|
||||
[omp-themes]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/master/Themes
|
||||
|
|
|
|||
|
|
@ -48,4 +48,4 @@ Display the currently active Angular CLI version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -41,4 +41,4 @@ to `true`
|
|||
- `.Profile`: `string` - the currently active profile
|
||||
- `.Region`: `string` - the currently active region
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -51,4 +51,4 @@ Display the currently active Azure subscription information.
|
|||
- `.User.Type`: `string` - user type
|
||||
- `.Origin`: `string` - where we received the information from, can be `CLI` or `PWSH`
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -54,4 +54,4 @@ Display the currently active Azure functions CLI version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -69,6 +69,6 @@ the same value as `Voltage`, for convenience
|
|||
- `.Error`: `string` - the error in case fetching the battery information failed
|
||||
- `.Icon`: `string` - the icon based on the battery state
|
||||
|
||||
[colors]: /docs/config-colors
|
||||
[colors]: /docs/configuration/colors
|
||||
[battery]: https://github.com/distatus/battery/blob/master/battery.go#L78
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -174,6 +174,6 @@ To display gravity as SG in XXXX format (e.g. "1020" instead of "1.020"), use th
|
|||
}
|
||||
````
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[brewfather]: http://brewfather.app
|
||||
[wikipedia_gravity_page]:https://en.wikipedia.org/wiki/Brix#Specific_gravity_2
|
||||
|
|
@ -53,5 +53,5 @@ Display the active [CDS CLI][sap-cap-cds] version.
|
|||
- `.Error`: `string` - when fetching the version string errors
|
||||
- `.HasDependency`: `bool` - a flag if `@sap/cds` was found in `package.json`
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[sap-cap-cds]: https://cap.cloud.sap/docs/tools/#command-line-interface-cli
|
||||
|
|
@ -51,5 +51,5 @@ Display the active [Cloud Foundry CLI][cloud-foundry] version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[cloud-foundry]: https://github.com/cloudfoundry/cli
|
||||
|
|
@ -38,5 +38,5 @@ Display the details of the logged [Cloud Foundry endpoint][cf-target] (`cf targe
|
|||
- `.URL`: `string` - Cloud Foundry API URL
|
||||
- `.User`: `string` - logged in user
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[cf-target]: https://cli.cloudfoundry.org/en-US/v8/target.html
|
||||
|
|
@ -59,5 +59,5 @@ error). The `&&` functionality will join the output of the commands when success
|
|||
|
||||
- `.Output`: `string` - the output of the command.
|
||||
|
||||
[env]: /docs/config-templates#environment-variables
|
||||
[templates]: /docs/config-templates
|
||||
[env]: /docs/configuration/templates#environment-variables
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -51,4 +51,4 @@ Display the currently active crystal version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -52,4 +52,4 @@ folder are present (default)
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -54,4 +54,4 @@ Display the currently active .NET SDK version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -64,4 +64,4 @@ Style specifies the format in which the time will be displayed. The table below
|
|||
- `.Ms`: `number` - the execution time in milliseconds
|
||||
- `.FormattedMs`: `string` - the formatted value based on the `style` above.
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -32,7 +32,7 @@ Displays the last exit code or that the last command failed based on the configu
|
|||
|
||||
- always_enabled: `boolean` - always show the status - defaults to `false`
|
||||
|
||||
[colors]: /docs/config-colors
|
||||
[colors]: /docs/configuration/colors
|
||||
|
||||
## Template ([info][templates])
|
||||
|
||||
|
|
@ -49,4 +49,4 @@ Displays the last exit code or that the last command failed based on the configu
|
|||
- `.Code`: `number` - the last known exit code
|
||||
- `.Meaning`: `string` - the textual meaning linked to exit code (if applicable, otherwise identical to `.Code`)
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -129,5 +129,5 @@ You can set the following properties to `true` to enable fetching additional inf
|
|||
- `.String`: `string` - a string representation of the changes above
|
||||
|
||||
[poshgit]: /docs/poshgit
|
||||
[templates]: /docs/config-templates
|
||||
[hyperlinks]: /docs/config-templates#helper-functions
|
||||
[templates]: /docs/configuration/templates
|
||||
[hyperlinks]: /docs/configuration/templates#helper-functions
|
||||
|
|
@ -52,4 +52,4 @@ Display the currently active golang version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -58,4 +58,4 @@ Using stack ghc will decrease performance.
|
|||
- `.Error`: `string` - when fetching the version string errors
|
||||
- `.StackGhc`: `boolean` - `true` if stack ghc was used, otherwise `false`
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -48,5 +48,5 @@ sidebar_label: Ipify
|
|||
|
||||
- .IP: `string` - Your external IP address
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[ipify]: https://www.ipify.org/
|
||||
|
|
@ -64,4 +64,4 @@ Display the currently active java version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -51,4 +51,4 @@ Display the currently active julia version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -51,5 +51,5 @@ Display the currently active [Kotlin][kotlin] version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[kotlin]: https://kotlinlang.org/
|
||||
|
|
@ -51,4 +51,4 @@ It is common for the Kubernetes "default" namespace to be used when no namespace
|
|||
|
||||
`{{.Context}} :: {{if .Namespace}}{{.Namespace}}{{else}}default{{end}}`
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -46,4 +46,4 @@ The Nerdbank.GitVersioning CLI can be a bit slow causing the prompt to feel slow
|
|||
- `.SimpleVersion`: `string` - the current simple version
|
||||
|
||||
[nbgv]: https://github.com/dotnet/Nerdbank.GitVersioning
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -104,5 +104,5 @@ Or display in mmol/l (instead of the default mg/dl) with the following template:
|
|||
- .TrendIcon: `string` - By default, this will be something like ↑↑ or ↘ etc but you can
|
||||
override them with any glpyh as seen above
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[nightscout]: http://www.nightscout.info/
|
||||
|
|
@ -55,4 +55,4 @@ Display the currently active node version.
|
|||
- `.PackageManagerIcon`: `string` - the Yarn on NPM icon when setting `fetch_package_manager` to `true`
|
||||
- `.Mismatch`: `boolean` - if the version in `.nvmrc` matches with `.Full`
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -39,4 +39,4 @@ Display the currently active npm version.
|
|||
- `.Patch`: `string` - patch number
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -63,4 +63,4 @@ Display OS specific info - defaults to Icon.
|
|||
|
||||
- `.Icon`: `string` - the OS icon
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -64,4 +64,4 @@ properties below - defaults to `{{.Weather}} ({{.Temperature}}{{.UnitIcon}})`
|
|||
- `.UnitIcon`: `string` - the current unit icon(based on units property)
|
||||
- `.URL`: `string` - the url of the current api call
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -148,4 +148,4 @@ folders at the same level, so if `C:\projectA\dev` and `C:\projectB\dev` exist,
|
|||
- `.Path`: `string` - the current directory (based on the `style` property)
|
||||
- `.StackCount`: `int` - the stack count
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -52,4 +52,4 @@ files are present (default)
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -99,5 +99,5 @@ You can set the following property to `true` to enable fetching additional infor
|
|||
- `.Changed`: `boolean` - if the status contains changes or not
|
||||
- `.String`: `string` - a string representation of the changes above
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[fa-issue]: https://github.com/FortAwesome/Font-Awesome/issues/18504
|
||||
|
|
@ -39,4 +39,4 @@ This segment only works within Powershell and requires the posh-git module to be
|
|||
- `.Status`: `string` - the status reported from posh-git
|
||||
|
||||
[posh-git]: https://github.com/dahlbyk/posh-git
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -44,4 +44,4 @@ Supports:
|
|||
- `.Version`: `string` - The version of your project
|
||||
- `.Name`: `string` - The name of your project
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -60,4 +60,4 @@ or not - defaults to `true`
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -52,5 +52,5 @@ Display the currently active [R][r-homepage] version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[r-homepage]: https://www.r-project.org/
|
||||
|
|
@ -31,4 +31,4 @@ Show when the current user is root or when in an elevated shell (Windows).
|
|||
|
||||
:::
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -51,4 +51,4 @@ Display the currently active ruby version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -51,4 +51,4 @@ Display the currently active rust version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -39,4 +39,4 @@ Show the current user and host name.
|
|||
- `.SSHSession`: `boolean` - active SSH session or not
|
||||
- `.Root`: `boolean` - are you a root/admin user or not
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -43,4 +43,4 @@ Show the current shell name (ZSH, powershell, bash, ...).
|
|||
|
||||
- `.Name`: `string` - the shell name
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -51,4 +51,4 @@ On macOS, all states are supported (playing/paused/stopped).
|
|||
- `.Track`: `string` - current track
|
||||
- `.Icon`: `string` - icon (based on `.Status`)
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -101,6 +101,6 @@ The properties below are available for use in your template
|
|||
|
||||
Now, go out and have a fun ride or run!
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[strava]: http://www.strava.com/
|
||||
[strava-connect]: https://www.strava.com/oauth/authorize?client_id=76033&response_type=code&redirect_uri=https://ohmyposh.dev/api/auth&approval_prompt=force&scope=read,activity:read
|
||||
|
|
@ -51,5 +51,5 @@ Display the currently active [Swift][swift] version.
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[swift]: https://www.swift.org/
|
||||
|
|
@ -54,4 +54,4 @@ Display SysInfo.
|
|||
|
||||
[cpuinfo]: https://github.com/shirou/gopsutil/blob/78065a7ce2021f6a78c8d6f586a2683ba501dcec/cpu/cpu.go#L32
|
||||
[ioinfo]: https://github.com/shirou/gopsutil/blob/e0ec1b9cda4470db704a862282a396986d7e930c/disk/disk.go#L32
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -45,4 +45,4 @@ defaults to `false`
|
|||
- `.WorkspaceName`: `string` - is the current workspace name
|
||||
- `.Version`: `string` - terraform version (set `fetch_version` to `true`)
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -31,5 +31,5 @@ Display text.
|
|||
- `.HostName`: `string` - the host name
|
||||
- `.Env.VarName`: `string` - Any environment variable where `VarName` is the environment variable name
|
||||
|
||||
[coloring]: /docs/config-colors
|
||||
[templates]: /docs/config-templates
|
||||
[coloring]: /docs/configuration/colors
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -76,5 +76,5 @@ Show the current timestamp.
|
|||
- StampMicro = "Jan _2 15:04:05.000000"
|
||||
- StampNano = "Jan _2 15:04:05.000000000"
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[format]: https://yourbasic.org/golang/format-parse-string-time-date-example/
|
||||
|
|
@ -54,6 +54,6 @@ see [the documentation][ui5-version-help]).
|
|||
- `.BuildMetadata`: `string` - build metadata
|
||||
- `.Error`: `string` - when fetching the version string errors
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
[ui5-homepage]: https://sap.github.io/ui5-tooling
|
||||
[ui5-version-help]: https://sap.github.io/ui5-tooling/pages/CLI/#ui5-versions
|
||||
|
|
@ -60,4 +60,4 @@ works if you can curl it yourself and a result. - defaults to ``
|
|||
|
||||
[wt]: https://wakatime.com
|
||||
[wk-summaries]: https://wakatime.com/developers#summaries
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -48,4 +48,4 @@ Currently only supports Windows and WSL. Pull requests for Darwin and Linux supp
|
|||
- `.TransmitRate`: `int` - the transmit rate (Mbps)
|
||||
- `.Signal`: `int` - the signal strength (%)
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -51,4 +51,4 @@ Supported registry key types:
|
|||
|
||||
- .Value: `string` - The result of your query, or fallback if not found.
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -54,6 +54,6 @@ Remote Control password.
|
|||
- `.Track`: `string` - current track
|
||||
- `.Icon`: `string` - icon (based on `.Status`)
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
||||
[templates]: /docs/config-templates
|
||||
[templates]: /docs/configuration/templates
|
||||
|
|
@ -17,7 +17,7 @@ Once you're ready to swap to a theme, follow the steps described in [🚀 Replac
|
|||
Themes with `minimal` in their names do not require a Nerd Font. Read about [🆎Fonts][fonts] for more information.
|
||||
|
||||
[themes]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/themes
|
||||
[fonts]: /docs/config-fonts
|
||||
[fonts]: /docs/configuration/fonts
|
||||
[replace-you-existing-prompt]: /docs/prompt
|
||||
|
||||
<!-- Do not change the content below, themes are rendered automatically -->
|
||||
|
|
|
|||
|
|
@ -107,5 +107,5 @@ Do not hesitate to [ask for assistance][issues] when you notice an issue or unex
|
|||
[introduction]: /docs/#concept
|
||||
[v3]: https://github.com/JanDeDobbeleer/oh-my-posh/
|
||||
[themesv3]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/themes
|
||||
[configuration]: /docs/config-overview
|
||||
[configuration]: /docs/configuration/overview
|
||||
[issues]: https://github.com/JanDeDobbeleer/oh-my-posh/issues/new
|
||||
|
|
|
|||
150
docs/sidebars.js
150
docs/sidebars.js
|
|
@ -17,13 +17,13 @@ module.exports = {
|
|||
label: "📦 Installation",
|
||||
collapsed: false,
|
||||
items: [
|
||||
"windows",
|
||||
"macos",
|
||||
"linux",
|
||||
"installation/windows",
|
||||
"installation/macos",
|
||||
"installation/linux",
|
||||
],
|
||||
},
|
||||
"prompt",
|
||||
"customize"
|
||||
"installation/prompt",
|
||||
"installation/customize"
|
||||
],
|
||||
},
|
||||
],
|
||||
|
|
@ -32,19 +32,19 @@ module.exports = {
|
|||
type: "category",
|
||||
label: "⚙️ Configuration",
|
||||
items: [
|
||||
"config-overview",
|
||||
"config-block",
|
||||
"config-segment",
|
||||
"config-sample",
|
||||
"config-title",
|
||||
"config-colors",
|
||||
"config-templates",
|
||||
"config-secondary-prompt",
|
||||
"config-debug-prompt",
|
||||
"config-transient",
|
||||
"config-line-error",
|
||||
"config-tooltips",
|
||||
"config-fonts",
|
||||
"configuration/overview",
|
||||
"configuration/block",
|
||||
"configuration/segment",
|
||||
"configuration/sample",
|
||||
"configuration/title",
|
||||
"configuration/colors",
|
||||
"configuration/templates",
|
||||
"configuration/secondary-prompt",
|
||||
"configuration/debug-prompt",
|
||||
"configuration/transient",
|
||||
"configuration/line-error",
|
||||
"configuration/tooltips",
|
||||
"configuration/fonts",
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
@ -52,59 +52,59 @@ module.exports = {
|
|||
label: "🌟 Segments",
|
||||
collapsed: true,
|
||||
items: [
|
||||
"angular",
|
||||
"aws",
|
||||
"az",
|
||||
"azfunc",
|
||||
"battery",
|
||||
"brewfather",
|
||||
"cds",
|
||||
"command",
|
||||
"crystal",
|
||||
"cf",
|
||||
"cftarget",
|
||||
"dart",
|
||||
"dotnet",
|
||||
"executiontime",
|
||||
"exit",
|
||||
"git",
|
||||
"poshgit",
|
||||
"golang",
|
||||
"haskell",
|
||||
"ipify",
|
||||
"java",
|
||||
"julia",
|
||||
"kotlin",
|
||||
"kubectl",
|
||||
"nbgv",
|
||||
"nightscout",
|
||||
"npm",
|
||||
"node",
|
||||
"os",
|
||||
"owm",
|
||||
"path",
|
||||
"php",
|
||||
"plastic",
|
||||
"project",
|
||||
"python",
|
||||
"r",
|
||||
"root",
|
||||
"ruby",
|
||||
"rust",
|
||||
"session",
|
||||
"shell",
|
||||
"spotify",
|
||||
"strava",
|
||||
"swift",
|
||||
"sysinfo",
|
||||
"terraform",
|
||||
"text",
|
||||
"time",
|
||||
"ui5tooling",
|
||||
"wakatime",
|
||||
"wifi",
|
||||
"winreg",
|
||||
"ytm",
|
||||
"segments/angular",
|
||||
"segments/aws",
|
||||
"segments/az",
|
||||
"segments/azfunc",
|
||||
"segments/battery",
|
||||
"segments/brewfather",
|
||||
"segments/cds",
|
||||
"segments/command",
|
||||
"segments/crystal",
|
||||
"segments/cf",
|
||||
"segments/cftarget",
|
||||
"segments/dart",
|
||||
"segments/dotnet",
|
||||
"segments/executiontime",
|
||||
"segments/exit",
|
||||
"segments/git",
|
||||
"segments/poshgit",
|
||||
"segments/golang",
|
||||
"segments/haskell",
|
||||
"segments/ipify",
|
||||
"segments/java",
|
||||
"segments/julia",
|
||||
"segments/kotlin",
|
||||
"segments/kubectl",
|
||||
"segments/nbgv",
|
||||
"segments/nightscout",
|
||||
"segments/npm",
|
||||
"segments/node",
|
||||
"segments/os",
|
||||
"segments/owm",
|
||||
"segments/path",
|
||||
"segments/php",
|
||||
"segments/plastic",
|
||||
"segments/project",
|
||||
"segments/python",
|
||||
"segments/r",
|
||||
"segments/root",
|
||||
"segments/ruby",
|
||||
"segments/rust",
|
||||
"segments/session",
|
||||
"segments/shell",
|
||||
"segments/spotify",
|
||||
"segments/strava",
|
||||
"segments/swift",
|
||||
"segments/sysinfo",
|
||||
"segments/terraform",
|
||||
"segments/text",
|
||||
"segments/time",
|
||||
"segments/ui5tooling",
|
||||
"segments/wakatime",
|
||||
"segments/wifi",
|
||||
"segments/winreg",
|
||||
"segments/ytm",
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
@ -112,10 +112,10 @@ module.exports = {
|
|||
label: "🙋🏾♀️ Contributing",
|
||||
collapsed: true,
|
||||
items: [
|
||||
"contributing_started",
|
||||
"contributing_segment",
|
||||
"contributing_git",
|
||||
"contributing_plastic",
|
||||
"contributing/started",
|
||||
"contributing/segment",
|
||||
"contributing/git",
|
||||
"contributing/plastic",
|
||||
],
|
||||
},
|
||||
"themes",
|
||||
|
|
|
|||
Loading…
Reference in a new issue