mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2025-02-02 05:41:10 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add all supported config formats

Browse source
This commit is contained in:
Jan De Dobbeleer 2023-03-31 20:55:36 +02:00 committed by Jan De Dobbeleer
parent ea19410f23
commit 4ff2dd233e
82 changed files with 448 additions and 559 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
website/docs/auth.mdx
View file

@ -4,6 +4,6 @@ title: Segment Authentication
sidebar_label: Authentication sidebar_label: Authentication
--- ---
import CodeBlock from '../src/components/Auth.js'; import CodeBlock from '@site/src/components/Auth.js';
<CodeBlock/> <CodeBlock/>

51
website/docs/configuration/block.mdx
View file

@ -4,66 +4,21 @@ title: Block
sidebar_label: Block sidebar_label: Block
--- ---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
Let's take a closer look at what defines a block. Let's take a closer look at what defines a block.
<Tabs import Config from '@site/src/components/Config.js';
defaultValue="json"
groupId="sample"
values={[
{ label: 'json', value: 'json', },
{ label: 'yaml', value: 'yaml', },
{ label: 'toml', value: 'toml', },
]
}>
<TabItem value="json">
```json <Config data={{
{
"$schema": "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json", "$schema": "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json",
...
"blocks": [ "blocks": [
{ {
"type": "prompt", "type": "prompt",
"alignment": "left", "alignment": "left",
"segments": [ "segments": [
...
] ]
} }
] ]
} }}/>
```
</TabItem>
<TabItem value="yaml">
```yaml
# yaml-language-server: $schema=https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json
---
blocks:
- type: prompt
alignment: left
segments: [...]
```
</TabItem>
<TabItem value="toml">
```toml
"$schema" = "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json"
[[blocks]]
type = "prompt"
alignment = "left"
segments = [
...
]
```
</TabItem>
</Tabs>
## Properties ## Properties

166
website/docs/configuration/example.mdx
View file

@ -4,22 +4,9 @@ title: Sample
sidebar_label: Sample sidebar_label: Sample
--- ---
import Tabs from "@theme/Tabs"; import Config from '@site/src/components/Config.js';
import TabItem from "@theme/TabItem"
<Tabs <Config data={{
defaultValue="json"
groupId="sample"
values={[
{ label: 'json', value: 'json', },
{ label: 'yaml', value: 'yaml', },
{ label: 'toml', value: 'toml', },
]
}>
<TabItem value="json">
```json
{
"$schema": "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json", "$schema": "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json",
"blocks": [ "blocks": [
{ {
@ -104,152 +91,5 @@ import TabItem from "@theme/TabItem"
], ],
"final_space": true, "final_space": true,
"version": 2 "version": 2
} }}/>
```
</TabItem>
<TabItem value="yaml">
```yaml
# yaml-language-server: $schema=https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json
blocks:
- type: rprompt
segments:
- foreground: "#007ACC"
template: " {{ .CurrentDate | date .Format }} "
properties:
time_format: '15:04:05'
style: plain
type: time
- alignment: left
newline: true
segments:
- background: "#ffb300"
foreground: "#ffffff"
leading_diamond: "\ue0b6"
template: " {{ .UserName }} "
style: diamond
trailing_diamond: "\ue0b0"
type: session
- background: "#61AFEF"
foreground: "#ffffff"
powerline_symbol: "\ue0b0"
template: " {{ .Path }} "
properties:
exclude_folders:
- "/super/secret/project"
style: folder
style: powerline
type: path
- background: "#2e9599"
background_templates:
- "{{ if or (.Working.Changed) (.Staging.Changed) }}#f36943{{ end }}"
- "{{ if and (gt .Ahead 0) (gt .Behind 0) }}#a8216b{{ end }}"
- "{{ if gt .Ahead 0 }}#35b5ff{{ end }}"
- "{{ if gt .Behind 0 }}#f89cfa{{ end }}"
foreground: "#193549"
foreground_templates:
- "{{ if and (gt .Ahead 0) (gt .Behind 0) }}#ffffff{{ end }}"
powerline_symbol: "\ue0b0"
template: " {{ .HEAD }}{{if .BranchStatus }} {{ .BranchStatus }}{{ end }} "
properties:
branch_max_length: 25
fetch_status: true
style: powerline
type: git
- background: "#00897b"
background_templates:
- "{{ if gt .Code 0 }}#e91e63{{ end }}"
foreground: "#ffffff"
template: "<parentBackground>\ue0b0</> \ue23a "
properties:
always_enabled: true
style: diamond
trailing_diamond: "\ue0b4"
type: exit
type: prompt
final_space: true
version: 2
```
</TabItem>
<TabItem value="toml">
```toml
"$schema" = "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json"
final_space = true
version = 2
[[blocks]]
type = "rprompt"
[[blocks.segments]]
foreground = "#007ACC"
template = " {{ .CurrentDate | date .Format }} "
style = "plain"
type = "time"
[blocks.segments.properties]
time_format = "15:04:05"
[[blocks]]
alignment = "left"
newline = true
type = "prompt"
[[blocks.segments]]
background = "#ffb300"
foreground = "#ffffff"
leading_diamond = "\ue0b6"
template = " {{ .UserName }} "
style = "diamond"
trailing_diamond = "\ue0b0"
type = "session"
[[blocks.segments]]
background = "#61AFEF"
foreground = "#ffffff"
powerline_symbol = "\ue0b0"
template = " {{ .Path }} "
style = "powerline"
type = "path"
[blocks.segments.properties]
exclude_folders = [ "/super/secret/project" ]
style = "folder"
[[blocks.segments]]
background = "#2e9599"
background_templates = [
"{{ if or (.Working.Changed) (.Staging.Changed) }}#f36943{{ end }}",
"{{ if and (gt .Ahead 0) (gt .Behind 0) }}#a8216b{{ end }}",
"{{ if gt .Ahead 0 }}#35b5ff{{ end }}",
"{{ if gt .Behind 0 }}#f89cfa{{ end }}"
]
foreground = "#193549"
foreground_templates = [ "{{ if and (gt .Ahead 0) (gt .Behind 0) }}#ffffff{{ end }}" ]
powerline_symbol = "\ue0b0"
template = " {{ .HEAD }}{{if .BranchStatus }} {{ .BranchStatus }}{{ end }} "
style = "powerline"
type = "git"
[blocks.segments.properties]
branch_max_length = 25
fetch_status = true
[[blocks.segments]]
background = "#00897b"
background_templates = [ "{{ if gt .Code 0 }}#e91e63{{ end }}" ]
foreground = "#ffffff"
template = "<parentBackground>\ue0b0</> \ue23a "
style = "diamond"
trailing_diamond = "\ue0b4"
type = "exit"
[blocks.segments.properties]
always_enabled = true
```
</TabItem>
</Tabs>

16
website/docs/configuration/tooltips.mdx
View file

@ -4,9 +4,6 @@ title: Tooltips
sidebar_label: Tooltips sidebar_label: Tooltips
--- ---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
:::info :::info
Due to limitations (or not having found a way just yet), this feature only works in `fish`, `zsh`, `powershell` Due to limitations (or not having found a way just yet), this feature only works in `fish`, `zsh`, `powershell`
(`ConstrainedLanguage` mode unsupported) and `cmd` (as of [Clink][clink] v1.2.46+) for the time being. (`ConstrainedLanguage` mode unsupported) and `cmd` (as of [Clink][clink] v1.2.46+) for the time being.
@ -24,12 +21,10 @@ the segment should be rendered.
You need to extend or create a custom theme with your tooltips. For example: You need to extend or create a custom theme with your tooltips. For example:
```json import Config from '@site/src/components/Config.js';
{
"$schema": "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json", <Config data={{
"blocks": [ "blocks": [],
...
],
"tooltips": [ "tooltips": [
{ {
"type": "git", "type": "git",
@ -46,8 +41,7 @@ You need to extend or create a custom theme with your tooltips. For example:
} }
} }
] ]
} }}/>
```
This configuration will render a right-aligned git segment when you type `git` or `g` followed by a space. This configuration will render a right-aligned git segment when you type `git` or `g` followed by a space.
A tip should not include any leading or trailing space but an interpolated one can be used, e.g., `g s`. A tip should not include any leading or trailing space but an interpolated one can be used, e.g., `g s`.

8
website/docs/contributing/segment.mdx
View file

@ -101,8 +101,9 @@ Display something new.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "new", "type": "new",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -111,8 +112,7 @@ Display something new.
"properties": { "properties": {
"newprop": "\uEFF1" "newprop": "\uEFF1"
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/angular.mdx
View file

@ -10,16 +10,16 @@ Display the currently active [Angular CLI][angular-cli-docs] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "angular", "type": "angular",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#000000", "foreground": "#000000",
"background": "#1976d2", "background": "#1976d2",
"template": " \uE753 {{ .Full }} " "template": " \uE753 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/aws.mdx
View file

@ -10,16 +10,16 @@ Display the currently active AWS profile and region.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "aws", "type": "aws",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#FFA400", "background": "#FFA400",
"template": " \uE7AD {{.Profile}}{{if .Region}}@{{.Region}}{{end}}" "template": " \uE7AD {{.Profile}}{{if .Region}}@{{.Region}}{{end}}"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/az.mdx
View file

@ -16,16 +16,16 @@ initializing Oh My Posh.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "az", "type": "az",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#000000", "foreground": "#000000",
"background": "#9ec3f0", "background": "#9ec3f0",
"template": " \uFD03 {{ .EnvironmentName }}" "template": " \uFD03 {{ .EnvironmentName }}"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/azfunc.mdx
View file

@ -10,8 +10,9 @@ Display the currently active [Azure Functions CLI][az-func-core-tools] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "azfunc", "type": "azfunc",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -22,8 +23,7 @@ Display the currently active [Azure Functions CLI][az-func-core-tools] version.
"fetch_version": true, "fetch_version": true,
"display_mode": "files" "display_mode": "files"
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/battery.mdx
View file

@ -14,8 +14,9 @@ Battery displays the remaining power percentage for your battery.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "battery", "type": "battery",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -32,8 +33,7 @@ Battery displays the remaining power percentage for your battery.
"charging_icon": "\uE234 ", "charging_icon": "\uE234 ",
"charged_icon": "\uE22F " "charged_icon": "\uE22F "
} }
} }}/>
```
## Properties ## Properties

12
website/docs/segments/brewfather.mdx
View file

@ -19,10 +19,13 @@ This example uses the default segment template to show a rendition of detail app
Additionally, the background of the segment will turn red if the latest reading is over 4 hours old - possibly helping indicate Additionally, the background of the segment will turn red if the latest reading is over 4 hours old - possibly helping indicate
an issue if, for example there is a Tilt or similar device that is supposed to be logging to Brewfather every 15 minutes. an issue if, for example there is a Tilt or similar device that is supposed to be logging to Brewfather every 15 minutes.
NOTE: Temperature units are in degrees C and specific gravity is expressed as `X.XXX` values. :::info
Temperature units are in degrees C and specific gravity is expressed as `X.XXX` values.
:::
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type":"brewfather", "type":"brewfather",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -36,8 +39,7 @@ NOTE: Temperature units are in degrees C and specific gravity is expressed as `X
"api_key":"qrstuvw78910", "api_key":"qrstuvw78910",
"batch_id":"hijklmno098765", "batch_id":"hijklmno098765",
} }
}, }}/>
```
## Properties ## Properties

8
website/docs/segments/buf.mdx
View file

@ -10,14 +10,14 @@ Display the currently active [Buf CLI][buf-docs] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "buf", "type": "buf",
"style": "plain", "style": "plain",
"foreground": "#1000D6", "foreground": "#1000D6",
"template": " 🐃 {{ .Full }} " "template": " 🐃 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/cds.mdx
View file

@ -10,16 +10,16 @@ Display the active [CDS CLI][sap-cap-cds] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"background": "#a7cae1", "background": "#a7cae1",
"foreground": "#100e23", "foreground": "#100e23",
"powerline_symbol": "\ue0b0", "powerline_symbol": "\ue0b0",
"template": " \ue311 cds {{ .Full }} ", "template": " \ue311 cds {{ .Full }} ",
"style": "powerline", "style": "powerline",
"type": "cds" "type": "cds"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/cf.mdx
View file

@ -10,16 +10,16 @@ Display the active [Cloud Foundry CLI][cloud-foundry] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"background": "#a7cae1", "background": "#a7cae1",
"foreground": "#100e23", "foreground": "#100e23",
"powerline_symbol": "\ue0b0", "powerline_symbol": "\ue0b0",
"template": " \uf40a cf {{ .Full }} ", "template": " \uf40a cf {{ .Full }} ",
"style": "powerline", "style": "powerline",
"type": "cf" "type": "cf"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/cftarget.mdx
View file

@ -10,16 +10,16 @@ Display the details of the logged [Cloud Foundry endpoint][cf-target] (`cf targe
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"background": "#a7cae1", "background": "#a7cae1",
"foreground": "#100e23", "foreground": "#100e23",
"powerline_symbol": "\ue0b0", "powerline_symbol": "\ue0b0",
"template": " \uf40a {{ .Org }}/{{ .Space }} ", "template": " \uf40a {{ .Org }}/{{ .Space }} ",
"style": "powerline", "style": "powerline",
"type": "cftarget" "type": "cftarget"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/cmake.mdx
View file

@ -10,16 +10,16 @@ Display the currently active [Cmake][cmake-github] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "cmake", "type": "cmake",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#E8EAEE", "foreground": "#E8EAEE",
"background": "#1E9748", "background": "#1E9748",
"template": " \ue61e \ue61d cmake {{ .Full }} " "template": " \ue61e \ue61d cmake {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/command.mdx
View file

@ -22,8 +22,9 @@ error). The `&&` functionality will join the output of the commands when success
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "prompt", "type": "prompt",
"alignment": "right", "alignment": "right",
"segments": [ "segments": [
@ -37,8 +38,7 @@ error). The `&&` functionality will join the output of the commands when success
} }
} }
] ]
} }}/>
```
## Properties ## Properties

8
website/docs/segments/connection.mdx
View file

@ -14,15 +14,15 @@ Currently only supports Windows. Pull requests for Darwin and Linux support are
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "connection", "type": "connection",
"style": "powerline", "style": "powerline",
"background": "#8822ee", "background": "#8822ee",
"foreground": "#222222", "foreground": "#222222",
"powerline_symbol": "\uE0B0" "powerline_symbol": "\uE0B0"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/crystal.mdx
View file

@ -10,16 +10,16 @@ Display the currently active crystal version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "crystal", "type": "crystal",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#4063D8", "background": "#4063D8",
"template": " \uE370 {{ .Full }} " "template": " \uE370 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/dart.mdx
View file

@ -10,16 +10,16 @@ Display the currently active dart version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "dart", "type": "dart",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#06A4CE", "background": "#06A4CE",
"template": " \uE798 {{ .Full }} " "template": " \uE798 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/deno.mdx
View file

@ -10,14 +10,14 @@ Display the currently active [Deno CLI][deno-docs] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "deno", "type": "deno",
"style": "plain", "style": "plain",
"foreground": "#3C82F6", "foreground": "#3C82F6",
"template": " \ufbe4 {{ .Full }} " "template": " \ufbe4 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/docker.mdx
View file

@ -10,16 +10,16 @@ Display the current Docker context. Will not be active when using the default co
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "docker", "type": "docker",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#000000", "foreground": "#000000",
"background": "#0B59E7", "background": "#0B59E7",
"template": " \uf308 {{ .Context }} " "template": " \uf308 {{ .Context }} "
} }}/>
```
## Template ([info][templates]) ## Template ([info][templates])

8
website/docs/segments/dotnet.mdx
View file

@ -10,16 +10,16 @@ Display the currently active [.NET SDK][net-sdk-docs] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "dotnet", "type": "dotnet",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#000000", "foreground": "#000000",
"background": "#00ffff", "background": "#00ffff",
"template": " \uE77F {{ .Full }} " "template": " \uE77F {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/elixir.mdx
View file

@ -10,16 +10,16 @@ Display the currently active elixir version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "elixir", "type": "elixir",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#422251", "background": "#422251",
"template": " \ue62d {{ .Full }} " "template": " \ue62d {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/executiontime.mdx
View file

@ -14,8 +14,9 @@ The installation guide shows how to include this argument for PowerShell and Zsh
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "executiontime", "type": "executiontime",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -26,8 +27,7 @@ The installation guide shows how to include this argument for PowerShell and Zsh
"threshold": 500, "threshold": 500,
"style": "austin" "style": "austin"
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/exit.mdx
View file

@ -10,8 +10,9 @@ Displays the last exit code or that the last command failed based on the configu
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "exit", "type": "exit",
"style": "diamond", "style": "diamond",
"foreground": "#ffffff", "foreground": "#ffffff",
@ -22,8 +23,7 @@ Displays the last exit code or that the last command failed based on the configu
"properties": { "properties": {
"always_enabled": true "always_enabled": true
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/flutter.mdx
View file

@ -10,16 +10,16 @@ Display the currently active flutter version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "flutter", "type": "flutter",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#06A4CE", "background": "#06A4CE",
"template": " \ue28e {{ .Full }} " "template": " \ue28e {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/fossil.mdx
View file

@ -10,15 +10,15 @@ Display [fossil][fossil] information when in a fossil repository.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "fossil", "type": "fossil",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#193549", "foreground": "#193549",
"background": "#ffeb3b" "background": "#ffeb3b"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/gcp.mdx
View file

@ -10,16 +10,16 @@ Display the currently active GCP project, region and account
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "gcp", "type": "gcp",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#47888d", "background": "#47888d",
"template": " \uE7B2 {{.Project}} :: {{.Account}} " "template": " \uE7B2 {{.Project}} :: {{.Account}} "
} }}/>
```
## Template ([info][templates]) ## Template ([info][templates])

8
website/docs/segments/git.mdx
View file

@ -35,8 +35,9 @@ You can then use the `POSH_GIT_STRING` environment variable in a [text segment][
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "git", "type": "git",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -57,8 +58,7 @@ You can then use the `POSH_GIT_STRING` environment variable in a [text segment][
"/Users/user/Projects/oh-my-posh/": "no" "/Users/user/Projects/oh-my-posh/": "no"
} }
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/gitversion.mdx
View file

@ -16,16 +16,16 @@ the value for 30 minutes by default.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "gitversion", "type": "gitversion",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#3a579b", "background": "#3a579b",
"template": " \uF1D2 {{ .MajorMinorPatch }} " "template": " \uF1D2 {{ .MajorMinorPatch }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/golang.mdx
View file

@ -10,16 +10,16 @@ Display the currently active golang version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "go", "type": "go",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#7FD5EA", "background": "#7FD5EA",
"template": " \u202D\uFCD1 {{ .Full }} " "template": " \u202D\uFCD1 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/haskell.mdx
View file

@ -10,16 +10,16 @@ Display the currently active Glasgow Haskell Compiler (GHC) version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "haskell", "type": "haskell",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#906cff", "foreground": "#906cff",
"background": "#100e23", "background": "#100e23",
"template": " \ue61f {{ .Full }}" "template": " \ue61f {{ .Full }}"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/ipify.mdx
View file

@ -10,8 +10,9 @@ sidebar_label: Ipify
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "ipify", "type": "ipify",
"style": "diamond", "style": "diamond",
"foreground": "#ffffff", "foreground": "#ffffff",
@ -23,8 +24,7 @@ sidebar_label: Ipify
"cache_timeout": 5, "cache_timeout": 5,
"http_timeout": 1000 "http_timeout": 1000
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/iterm.mdx
View file

@ -29,15 +29,15 @@ You do not need to add this segment.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "iterm", "type": "iterm",
"interactive": true, "interactive": true,
"style": "plain", "style": "plain",
"foreground": "#80ffea", "foreground": "#80ffea",
"template": "{{ .PromptMark }}" "template": "{{ .PromptMark }}"
} }}/>
```
## Template ([info][templates]) ## Template ([info][templates])

8
website/docs/segments/java.mdx
View file

@ -10,16 +10,16 @@ Display the currently active java version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "java", "type": "java",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#4063D8", "background": "#4063D8",
"template": " \uE738 {{ .Full }}" "template": " \uE738 {{ .Full }}"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/julia.mdx
View file

@ -10,16 +10,16 @@ Display the currently active julia version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "julia", "type": "julia",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#4063D8", "background": "#4063D8",
"template": " \uE624 {{ .Full }} " "template": " \uE624 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/kotlin.mdx
View file

@ -10,16 +10,16 @@ Display the currently active [Kotlin][kotlin] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "kotlin", "type": "kotlin",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#906cff", "background": "#906cff",
"template": " \ufa05 {{ .Full }} " "template": " \ufa05 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/kubectl.mdx
View file

@ -10,16 +10,16 @@ Display the currently active Kubernetes context name and namespace name.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "kubectl", "type": "kubectl",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#000000", "foreground": "#000000",
"background": "#ebcc34", "background": "#ebcc34",
"template": " \uFD31 {{.Context}}{{if .Namespace}} :: {{.Namespace}}{{end}} " "template": " \uFD31 {{.Context}}{{if .Namespace}} :: {{.Namespace}}{{end}} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/lua.mdx
View file

@ -10,16 +10,16 @@ Display the currently active [Lua][lua] or [LuaJIT][luajit] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "lua", "type": "lua",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\ue0b0", "powerline_symbol": "\ue0b0",
"foreground": "white", "foreground": "white",
"background": "blue", "background": "blue",
"template": " \ue620 {{ .Full }} " "template": " \ue620 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/mercurial.mdx
View file

@ -11,8 +11,9 @@ make sure your `hg` executable is up-to-date (when branch or status information
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "mercurial", "type": "mercurial",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -21,8 +22,7 @@ make sure your `hg` executable is up-to-date (when branch or status information
"properties": { "properties": {
"newprop": "\uEFF1" "newprop": "\uEFF1"
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/nbgv.mdx
View file

@ -14,16 +14,16 @@ The Nerdbank.GitVersioning CLI can be a bit slow causing the prompt to feel slow
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "nbgv", "type": "nbgv",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#3a579a", "background": "#3a579a",
"template": " \uF1D2 {{ .Version }} " "template": " \uF1D2 {{ .Version }} "
} }}/>
```
## Template ([info][templates]) ## Template ([info][templates])

9
website/docs/segments/nightscout.mdx
View file

@ -23,8 +23,9 @@ white text on a yellow background, for example.
The `foreground_templates` example below could be set to just a single color, The `foreground_templates` example below could be set to just a single color,
if that color is visible against any of your backgrounds. if that color is visible against any of your backgrounds.
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "nightscout", "type": "nightscout",
"style": "diamond", "style": "diamond",
"foreground": "#ffffff", "foreground": "#ffffff",
@ -39,7 +40,6 @@ if that color is visible against any of your backgrounds.
"{{ if lt .Sgv 60 }}#000000{{ end }}", "{{ if lt .Sgv 60 }}#000000{{ end }}",
"#000000" "#000000"
], ],
"leading_diamond": "\ue0b6", "leading_diamond": "\ue0b6",
"trailing_diamond": "\uE0B0", "trailing_diamond": "\uE0B0",
"template": "\ue2a1 {{ .Sgv }}{{ .TrendIcon }}", "template": "\ue2a1 {{ .Sgv }}{{ .TrendIcon }}",
@ -47,8 +47,7 @@ if that color is visible against any of your backgrounds.
"url": "https://YOURNIGHTSCOUTAPP.herokuapp.com/api/v1/entries.json?count=1&token=APITOKENFROMYOURADMIN", "url": "https://YOURNIGHTSCOUTAPP.herokuapp.com/api/v1/entries.json?count=1&token=APITOKENFROMYOURADMIN",
"http_timeout": 1500 "http_timeout": 1500
} }
} }}/>
```
Or display in mmol/l (instead of the default mg/dl) with the following template: Or display in mmol/l (instead of the default mg/dl) with the following template:

8
website/docs/segments/node.mdx
View file

@ -10,16 +10,16 @@ Display the currently active [Node.js][node-js] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "node", "type": "node",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#6CA35E", "background": "#6CA35E",
"template": " \uE718 {{ .Full }} " "template": " \uE718 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/npm.mdx
View file

@ -10,16 +10,16 @@ Display the currently active [npm][npm-docs] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "npm", "type": "npm",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#193549", "foreground": "#193549",
"background": "#ffeb3b", "background": "#ffeb3b",
"template": "\ue71e {{ .Full }} " "template": "\ue71e {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/nx.mdx
View file

@ -10,16 +10,16 @@ Display the currently active [Nx][nx-docs] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "nx", "type": "nx",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#000000", "foreground": "#000000",
"background": "#1976d2", "background": "#1976d2",
"template": " \uE753 {{ .Full }} " "template": " \uE753 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/os.mdx
View file

@ -10,8 +10,9 @@ Display OS specific info - defaults to Icon.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "os", "type": "os",
"style": "plain", "style": "plain",
"foreground": "#26C6DA", "foreground": "#26C6DA",
@ -20,8 +21,7 @@ Display OS specific info - defaults to Icon.
"properties": { "properties": {
"macos": "mac" "macos": "mac"
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/owm.mdx
View file

@ -15,8 +15,9 @@ The free tier for _Current weather and forecasts collection_ is sufficient.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "owm", "type": "owm",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -30,8 +31,7 @@ The free tier for _Current weather and forecasts collection_ is sufficient.
"http_timeout": 20, "http_timeout": 20,
"cache_timeout": 10 "cache_timeout": 10
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/path.mdx
View file

@ -10,8 +10,9 @@ Display the current path.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "path", "type": "path",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -23,8 +24,7 @@ Display the current path.
"C:\\temp": "\ue799" "C:\\temp": "\ue799"
} }
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/perl.mdx
View file

@ -10,16 +10,16 @@ Display the currently active perl version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "perl", "type": "perl",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#4063D8", "background": "#4063D8",
"template": " \ue769 {{ .Full }}" "template": " \ue769 {{ .Full }}"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/php.mdx
View file

@ -10,16 +10,16 @@ Display the currently active php version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "php", "type": "php",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#4063D8", "background": "#4063D8",
"template": " \ue73d {{ .Full }} " "template": " \ue73d {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/plastic.mdx
View file

@ -12,8 +12,9 @@ For maximum compatibility, make sure your `cm` executable is up-to-date
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "plastic", "type": "plastic",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -31,8 +32,7 @@ For maximum compatibility, make sure your `cm` executable is up-to-date
"branch_max_length": 25, "branch_max_length": 25,
"truncate_symbol": "\u2026" "truncate_symbol": "\u2026"
} }
} }}/>
```
## Plastic SCM Icon ## Plastic SCM Icon

20
website/docs/segments/project.mdx
View file

@ -18,24 +18,24 @@ Supports:
- .NET project (`*.csproj`, `*.vbproj` or `*.fsproj`, first file match info is displayed) - .NET project (`*.csproj`, `*.vbproj` or `*.fsproj`, first file match info is displayed)
- Julia project (`JuliaProject.toml`, `Project.toml`) - Julia project (`JuliaProject.toml`, `Project.toml`)
## Properties
| Name | Type | Description |
| ---------------- | --------- | --------------------------------------------- |
| `always_enabled` | `boolean` | always show the segment - defaults to `false` |
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "project", "type": "project",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#193549", "foreground": "#193549",
"background": "#ffeb3b", "background": "#ffeb3b",
"template": " {{ if .Error }}{{ .Error }}{{ else }}{{ if .Version }}\uf487 {{.Version}}{{ end }} {{ if .Name }}{{ .Name }}{{ end }}{{ end }} " "template": " {{ if .Error }}{{ .Error }}{{ else }}{{ if .Version }}\uf487 {{.Version}}{{ end }} {{ if .Name }}{{ .Name }}{{ end }}{{ end }} "
} }}/>
```
## Properties
| Name | Type | Description |
| ---------------- | --------- | --------------------------------------------- |
| `always_enabled` | `boolean` | always show the segment - defaults to `false` |
## Template ([info][templates]) ## Template ([info][templates])

8
website/docs/segments/python.mdx
View file

@ -11,16 +11,16 @@ Supports conda, virtualenv and pyenv (if python points to pyenv shim).
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "python", "type": "python",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#100e23", "foreground": "#100e23",
"background": "#906cff", "background": "#906cff",
"template": " \uE235 {{ .Full }} " "template": " \uE235 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/r.mdx
View file

@ -10,16 +10,16 @@ Display the currently active [R][r-homepage] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "r", "type": "r",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "blue", "foreground": "blue",
"background": "lightWhite", "background": "lightWhite",
"template": " R {{ .Full }} " "template": " R {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/root.mdx
View file

@ -10,16 +10,16 @@ Show when the current user is root or when in an elevated shell (Windows).
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "root", "type": "root",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#111111", "foreground": "#111111",
"background": "#ffff66", "background": "#ffff66",
"template": "\uF0E7" "template": "\uF0E7"
} }}/>
```
## Template ([info][templates]) ## Template ([info][templates])

8
website/docs/segments/ruby.mdx
View file

@ -10,16 +10,16 @@ Display the currently active ruby version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "ruby", "type": "ruby",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#4063D8", "background": "#4063D8",
"template": " \uE791 {{ .Full }}" "template": " \uE791 {{ .Full }}"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/rust.mdx
View file

@ -10,16 +10,16 @@ Display the currently active rust version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "rust", "type": "rust",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#193549", "foreground": "#193549",
"background": "#99908a", "background": "#99908a",
"template": " \uE7a8 {{ .Full }} " "template": " \uE7a8 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/sapling.mdx
View file

@ -10,8 +10,9 @@ Display [sapling][sapling] information when in a sapling repository.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "sapling", "type": "sapling",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -21,8 +22,7 @@ Display [sapling][sapling] information when in a sapling repository.
"properties": { "properties": {
"fetch_status": true "fetch_status": true
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/session.mdx
View file

@ -10,8 +10,9 @@ Show the current user and host name.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "session", "type": "session",
"style": "diamond", "style": "diamond",
"foreground": "#ffffff", "foreground": "#ffffff",
@ -19,8 +20,7 @@ Show the current user and host name.
"leading_diamond": "\uE0B6", "leading_diamond": "\uE0B6",
"trailing_diamond": "\uE0B0", "trailing_diamond": "\uE0B0",
"template": "{{ if .SSHSession }}\uF817 {{ end }}{{ .UserName }}" "template": "{{ if .SSHSession }}\uF817 {{ end }}{{ .UserName }}"
} }}/>
```
## Template ([info][templates]) ## Template ([info][templates])

8
website/docs/segments/shell.mdx
View file

@ -10,8 +10,9 @@ Show the current shell name (zsh, PowerShell, bash, ...).
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "shell", "type": "shell",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -22,8 +23,7 @@ Show the current shell name (zsh, PowerShell, bash, ...).
"pwsh": "PS" "pwsh": "PS"
} }
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/spotify.mdx
View file

@ -19,8 +19,9 @@ fetching information from the native Spotify application and Edge PWA.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "spotify", "type": "spotify",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -31,8 +32,7 @@ fetching information from the native Spotify application and Edge PWA.
"paused_icon": "\uF8E3 ", "paused_icon": "\uF8E3 ",
"stopped_icon": "\uF04D " "stopped_icon": "\uF04D "
} }
} }}/>
```
## Properties ## Properties

10
website/docs/segments/strava.mdx
View file

@ -4,8 +4,6 @@ title: Strava
sidebar_label: Strava sidebar_label: Strava
--- ---
import StravaConnect from "/img/strava_connect.svg";
## What ## What
[Strava][strava] is a popular activity tracker for bike, run or any other training. [Strava][strava] is a popular activity tracker for bike, run or any other training.
@ -30,8 +28,9 @@ This configuration sets the background green if you have an activity the last tw
orange if you have one last 5 days, and red otherwise. The `foreground_templates` example below could be set to just a single color, orange if you have one last 5 days, and red otherwise. The `foreground_templates` example below could be set to just a single color,
if that color is visible against any of your backgrounds. if that color is visible against any of your backgrounds.
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "strava", "type": "strava",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -53,8 +52,7 @@ if that color is visible against any of your backgrounds.
"refresh_token": "1111111111111111", "refresh_token": "1111111111111111",
"http_timeout": 1500 "http_timeout": 1500
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/svn.mdx
View file

@ -11,8 +11,9 @@ make sure your `svn` executable is up-to-date (when branch or status information
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "svn", "type": "svn",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -21,8 +22,7 @@ make sure your `svn` executable is up-to-date (when branch or status information
"properties": { "properties": {
"fetch_status": true "fetch_status": true
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/swift.mdx
View file

@ -10,16 +10,16 @@ Display the currently active [Swift][swift] version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "swift", "type": "swift",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#f6553c", "background": "#f6553c",
"template": " \ue755 {{ .Full }} " "template": " \ue755 {{ .Full }} "
} }}/>
```
## Properties ## Properties

8
website/docs/segments/sysinfo.mdx
View file

@ -10,8 +10,9 @@ Display SysInfo.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type":"sysinfo", "type":"sysinfo",
"powerline_symbol": "\ue0b0", "powerline_symbol": "\ue0b0",
"foreground": "#ffffff", "foreground": "#ffffff",
@ -21,8 +22,7 @@ Display SysInfo.
"precision": 2 "precision": 2
}, },
"style":"powerline" "style":"powerline"
}, }}/>
```
## Properties ## Properties

8
website/docs/segments/terraform.mdx
View file

@ -14,16 +14,16 @@ This requires a terraform binary in your PATH and will only show in directories
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "terraform", "type": "terraform",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#000000", "foreground": "#000000",
"background": "#ebcc34", "background": "#ebcc34",
"template": "{{.WorkspaceName}}" "template": "{{.WorkspaceName}}"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/text.mdx
View file

@ -10,14 +10,14 @@ Display text.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "text", "type": "text",
"style": "plain", "style": "plain",
"foreground": "#E06C75", "foreground": "#E06C75",
"template": "\u276F" "template": "\u276F"
} }}/>
```
## Template ([info][templates]) ## Template ([info][templates])

8
website/docs/segments/time.mdx
View file

@ -10,16 +10,16 @@ Show the current timestamp.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "time", "type": "time",
"style": "plain", "style": "plain",
"foreground": "#007ACC", "foreground": "#007ACC",
"properties": { "properties": {
"time_format": "15:04:05" "time_format": "15:04:05"
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/ui5tooling.mdx
View file

@ -11,16 +11,16 @@ see [the documentation][ui5-version-help]).
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"background": "#f5a834", "background": "#f5a834",
"foreground": "#100e23", "foreground": "#100e23",
"powerline_symbol": "\ue0b0", "powerline_symbol": "\ue0b0",
"template": " \ufab6ui5 {{ .Full }} ", "template": " \ufab6ui5 {{ .Full }} ",
"style": "powerline", "style": "powerline",
"type": "ui5tooling" "type": "ui5tooling"
} }}/>
```
## Properties ## Properties

8
website/docs/segments/unity.mdx
View file

@ -21,8 +21,9 @@ This segment always chooses the higher version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "unity", "type": "unity",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\ue0b0", "powerline_symbol": "\ue0b0",
@ -31,8 +32,7 @@ This segment always chooses the higher version.
"properties": { "properties": {
"http_timeout": 2000 "http_timeout": 2000
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/vala.mdx
View file

@ -10,16 +10,16 @@ Display the currently active vala version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "vala", "type": "vala",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#ffffff", "foreground": "#ffffff",
"background": "#5E20A4", "background": "#5E20A4",
"template": " \ue69e {{ .Full }} " "template": " \ue69e {{ .Full }} "
} }}/>
```
## Properties ## Properties

30
website/docs/segments/wakatime.mdx
View file

@ -9,28 +9,26 @@ sidebar_label: Wakatime
Shows the tracked time on [wakatime][wt] of the current day Shows the tracked time on [wakatime][wt] of the current day
:::caution :::caution
You **must** request an API key at the [wakatime][wt] website. You **must** request an API key at the [wakatime][wt] website.
The free tier for is sufficient. You'll find the API key in your profile settings page. The free tier for is sufficient. You'll find the API key in your profile settings page.
::: :::
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
"type": "wakatime", <Config data={{
"style": "powerline", "type": "wakatime",
"powerline_symbol": "\uE0B0", "style": "powerline",
"foreground": "#ffffff", "powerline_symbol": "\uE0B0",
"background": "#007acc", "foreground": "#ffffff",
"properties": { "background": "#007acc",
"url": "https://wakatime.com/api/v1/users/current/summaries?start=today&end=today&api_key=API_KEY", "properties": {
"cache_timeout": 10, "url": "https://wakatime.com/api/v1/users/current/summaries?start=today&end=today&api_key=API_KEY",
"http_timeout": 500 "cache_timeout": 10,
} "http_timeout": 500
}, }
``` }}/>
## Properties ## Properties

28
website/docs/segments/winreg.mdx
View file

@ -18,20 +18,20 @@ Supported registry key types:
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
"type": "winreg", <Config data={{
"style": "powerline", "type": "winreg",
"powerline_symbol": "\uE0B0", "style": "powerline",
"foreground": "#ffffff", "powerline_symbol": "\uE0B0",
"background": "#444444", "foreground": "#ffffff",
"template":" \uE62A {{ .Value }}", "background": "#444444",
"properties": { "template":" \uE62A {{ .Value }}",
"path": "HKLM\\software\\microsoft\\windows nt\\currentversion\\buildlab", "properties": {
"fallback":"unknown" "path": "HKLM\\software\\microsoft\\windows nt\\currentversion\\buildlab",
} "fallback":"unknown"
}, }
``` }}/>
## Properties ## Properties

8
website/docs/segments/withings.mdx
View file

@ -26,8 +26,9 @@ Click the following link to connect with Withings:
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "withings", "type": "withings",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -39,8 +40,7 @@ Click the following link to connect with Withings:
"refresh_token": "1111111111111111", "refresh_token": "1111111111111111",
"http_timeout": 1500 "http_timeout": 1500
} }
} }}/>
```
## Properties ## Properties

8
website/docs/segments/xmake.mdx
View file

@ -10,16 +10,16 @@ Display the currently active xmake version.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "xmake", "type": "xmake",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
"foreground": "#e0f2f1", "foreground": "#e0f2f1",
"background": "#22a079", "background": "#22a079",
"template": " xmake v{{ .Full }} " "template": " xmake v{{ .Full }} "
}, }}/>
```
## Properties ## Properties

8
website/docs/segments/ytm.mdx
View file

@ -15,8 +15,9 @@ Remote Control password.
## Sample Configuration ## Sample Configuration
```json import Config from '@site/src/components/Config.js';
{
<Config data={{
"type": "ytm", "type": "ytm",
"style": "powerline", "style": "powerline",
"powerline_symbol": "\uE0B0", "powerline_symbol": "\uE0B0",
@ -27,8 +28,7 @@ Remote Control password.
"paused_icon": "\uF8E3 ", "paused_icon": "\uF8E3 ",
"stopped_icon": "\uF04D " "stopped_icon": "\uF04D "
} }
} }}/>
```
## Properties ## Properties

71
website/package-lock.json generated
View file

@ -11,10 +11,12 @@
"@docusaurus/core": "^2.3.1", "@docusaurus/core": "^2.3.1",
"@docusaurus/preset-classic": "^2.3.1", "@docusaurus/preset-classic": "^2.3.1",
"@docusaurus/theme-search-algolia": "^2.3.1", "@docusaurus/theme-search-algolia": "^2.3.1",
"@iarna/toml": "^2.2.5",
"classnames": "^2.3.2", "classnames": "^2.3.2",
"query-string": "7.1.1", "query-string": "7.1.1",
"react": "17.0.2", "react": "17.0.2",
"react-dom": "17.0.2" "react-dom": "17.0.2",
"yaml": "^2.2.1"
}, },
"devDependencies": { "devDependencies": {
"cross-env": "^7.0.3", "cross-env": "^7.0.3",
@ -2585,6 +2587,11 @@
"@hapi/hoek": "^9.0.0" "@hapi/hoek": "^9.0.0"
} }
}, },
"node_modules/@iarna/toml": {
"version": "2.2.5",
"resolved": "https://registry.npmjs.org/@iarna/toml/-/toml-2.2.5.tgz",
"integrity": "sha512-trnsAYxU3xnS1gPHPyU961coFyLkh4gAD/0zQ5mymY4yOZ+CYvsPqUbOFSw0aDM4y0tV7tiFxL/1XfXPNC6IPg=="
},
"node_modules/@jest/schemas": { "node_modules/@jest/schemas": {
"version": "29.0.0", "version": "29.0.0",
"resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.0.0.tgz", "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.0.0.tgz",
@ -5089,6 +5096,14 @@
"node": ">=10" "node": ">=10"
} }
}, },
"node_modules/cosmiconfig/node_modules/yaml": {
"version": "1.10.2",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz",
"integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==",
"engines": {
"node": ">= 6"
}
},
"node_modules/create-ecdh": { "node_modules/create-ecdh": {
"version": "4.0.4", "version": "4.0.4",
"resolved": "https://registry.npmjs.org/create-ecdh/-/create-ecdh-4.0.4.tgz", "resolved": "https://registry.npmjs.org/create-ecdh/-/create-ecdh-4.0.4.tgz",
@ -5470,6 +5485,14 @@
"postcss": "^8.2.15" "postcss": "^8.2.15"
} }
}, },
"node_modules/cssnano/node_modules/yaml": {
"version": "1.10.2",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz",
"integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==",
"engines": {
"node": ">= 6"
}
},
"node_modules/csso": { "node_modules/csso": {
"version": "4.2.0", "version": "4.2.0",
"resolved": "https://registry.npmjs.org/csso/-/csso-4.2.0.tgz", "resolved": "https://registry.npmjs.org/csso/-/csso-4.2.0.tgz",
@ -6592,6 +6615,14 @@
"node": ">=6" "node": ">=6"
} }
}, },
"node_modules/fork-ts-checker-webpack-plugin/node_modules/yaml": {
"version": "1.10.2",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz",
"integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==",
"engines": {
"node": ">= 6"
}
},
"node_modules/forwarded": { "node_modules/forwarded": {
"version": "0.2.0", "version": "0.2.0",
"resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz",
@ -13333,11 +13364,11 @@
"integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="
}, },
"node_modules/yaml": { "node_modules/yaml": {
"version": "1.10.2", "version": "2.2.1",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.2.1.tgz",
"integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==", "integrity": "sha512-e0WHiYql7+9wr4cWMx3TVQrNwejKaEe7/rHNmQmqRjazfOP5W8PB6Jpebb5o6fIapbz9o9+2ipcaTM2ZwDI6lw==",
"engines": { "engines": {
"node": ">= 6" "node": ">= 14"
} }
}, },
"node_modules/yocto-queue": { "node_modules/yocto-queue": {
@ -15178,6 +15209,11 @@
"@hapi/hoek": "^9.0.0" "@hapi/hoek": "^9.0.0"
} }
}, },
"@iarna/toml": {
"version": "2.2.5",
"resolved": "https://registry.npmjs.org/@iarna/toml/-/toml-2.2.5.tgz",
"integrity": "sha512-trnsAYxU3xnS1gPHPyU961coFyLkh4gAD/0zQ5mymY4yOZ+CYvsPqUbOFSw0aDM4y0tV7tiFxL/1XfXPNC6IPg=="
},
"@jest/schemas": { "@jest/schemas": {
"version": "29.0.0", "version": "29.0.0",
"resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.0.0.tgz", "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.0.0.tgz",
@ -17095,6 +17131,13 @@
"parse-json": "^5.0.0", "parse-json": "^5.0.0",
"path-type": "^4.0.0", "path-type": "^4.0.0",
"yaml": "^1.10.0" "yaml": "^1.10.0"
},
"dependencies": {
"yaml": {
"version": "1.10.2",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz",
"integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg=="
}
} }
}, },
"create-ecdh": { "create-ecdh": {
@ -17303,6 +17346,13 @@
"cssnano-preset-default": "^5.2.13", "cssnano-preset-default": "^5.2.13",
"lilconfig": "^2.0.3", "lilconfig": "^2.0.3",
"yaml": "^1.10.2" "yaml": "^1.10.2"
},
"dependencies": {
"yaml": {
"version": "1.10.2",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz",
"integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg=="
}
} }
}, },
"cssnano-preset-advanced": { "cssnano-preset-advanced": {
@ -18209,6 +18259,11 @@
"version": "1.1.3", "version": "1.1.3",
"resolved": "https://registry.npmjs.org/tapable/-/tapable-1.1.3.tgz", "resolved": "https://registry.npmjs.org/tapable/-/tapable-1.1.3.tgz",
"integrity": "sha512-4WK/bYZmj8xLr+HUCODHGF1ZFzsYffasLUgEiMBY4fgtltdO6B4WJtlSbPaDTLpYTcGVwM2qLnFTICEcNxs3kA==" "integrity": "sha512-4WK/bYZmj8xLr+HUCODHGF1ZFzsYffasLUgEiMBY4fgtltdO6B4WJtlSbPaDTLpYTcGVwM2qLnFTICEcNxs3kA=="
},
"yaml": {
"version": "1.10.2",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz",
"integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg=="
} }
} }
}, },
@ -23010,9 +23065,9 @@
"integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="
}, },
"yaml": { "yaml": {
"version": "1.10.2", "version": "2.2.1",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.2.1.tgz",
"integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==" "integrity": "sha512-e0WHiYql7+9wr4cWMx3TVQrNwejKaEe7/rHNmQmqRjazfOP5W8PB6Jpebb5o6fIapbz9o9+2ipcaTM2ZwDI6lw=="
}, },
"yocto-queue": { "yocto-queue": {
"version": "0.1.0", "version": "0.1.0",

6
website/package.json
View file

@ -11,12 +11,14 @@
"@docusaurus/core": "^2.3.1", "@docusaurus/core": "^2.3.1",
"@docusaurus/preset-classic": "^2.3.1", "@docusaurus/preset-classic": "^2.3.1",
"@docusaurus/theme-search-algolia": "^2.3.1", "@docusaurus/theme-search-algolia": "^2.3.1",
"@iarna/toml": "^2.2.5",
"classnames": "^2.3.2", "classnames": "^2.3.2",
"query-string": "7.1.1", "query-string": "7.1.1",
"react": "17.0.2", "react": "17.0.2",
"react-dom": "17.0.2" "react-dom": "17.0.2",
"yaml": "^2.2.1"
}, },
"resolutions":{ "resolutions": {
"trim": "^0.0.3", "trim": "^0.0.3",
"got": "^11.8.5" "got": "^11.8.5"
}, },

41
website/src/components/Config.js Normal file
View file

@ -0,0 +1,41 @@
import React from 'react';
import CodeBlock from '@theme/CodeBlock';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import YAML from 'yaml';
import TOML from '@iarna/toml';
function Config(props) {
const {data} = props;
return (
<Tabs
defaultValue="json"
groupId="sample"
values={[
{ label: 'json', value: 'json', },
{ label: 'yaml', value: 'yaml', },
{ label: 'toml', value: 'toml', },
]
}>
<TabItem value="json">
<CodeBlock className="language-json">
{JSON.stringify(data, null, 2)}
</CodeBlock>
</TabItem>
<TabItem value="yaml">
<CodeBlock className="language-yaml">
{YAML.stringify(data)}
</CodeBlock>
</TabItem>
<TabItem value="toml">
<CodeBlock className="language-toml">
{TOML.stringify(data)}
</CodeBlock>
</TabItem>
</Tabs>
);
}
export default Config;

9
website/src/css/custom.css
View file

@ -213,18 +213,23 @@ a.getStarted_Sjon {
/* Fonts */ /* Fonts */
@font-face {
font-family: "Victor Mono";
src: url('/static/fonts/VictorMono.ttf') format("truetype");
}
:root { :root {
--ifm-font-family-monospace: "Inter"; --ifm-font-family-monospace: "Inter";
--ifm-font-family-base: "Inter"; --ifm-font-family-base: "Inter";
} }
code { code {
font-family: "Fira Code", monospace; font-family: "Victor Mono", monospace;
} }
code[class*="language-"], code[class*="language-"],
pre[class*="language-"] { pre[class*="language-"] {
font-family: "Fira Code", monospace; font-family: "Victor Mono", monospace;
} }
/* Dev settings */ /* Dev settings */

BIN
website/static/fonts/VictorMono.ttf Normal file
View file

Binary file not shown.