docs: minor corrections

This commit is contained in:
Daksh P. Jain 2021-07-01 23:05:09 +05:30 committed by GitHub
parent 8cf85a370d
commit ce913e6929
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 38 additions and 38 deletions

View file

@ -1,7 +1,7 @@
### Prerequisites
- [ ] I have read and understand the `CONTRIBUTING` guide
- [ ] I looked for duplicate issues before submitting this one
- [ ] I have read and understood the `CONTRIBUTING` guide
- [ ] I have looked for duplicate issues before submitting this one
### Description

View file

@ -1,9 +1,9 @@
### Prerequisites
- [ ] I have read and understand the `CONTRIBUTING` guide
- [ ] I have read and understood the `CONTRIBUTING` guide
- [ ] The commit message follows the [conventional commits][cc] guidelines
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
- [ ] Tests for the changes have been added (for bug fixes/features)
- [ ] Docs have been added / updated (for bug fixes/features)
### Description
@ -11,8 +11,8 @@
### Tips
If you're not comfortable working with git, we're working a [guide][docs] to help you out.
Oh My Posh advises [GitKraken][kraken] as your preferred cross platfrom git GUI powertool.
If you're not comfortable with working with Git, we're working a [guide][docs] to help you out.
Oh My Posh advises [GitKraken][kraken] as your preferred cross platform Git GUI power tool.
[cc]: https://www.conventionalcommits.org/en/v1.0.0/#summary
[docs]: https://ohmyposh.dev/docs/contributing_git

View file

@ -10,12 +10,12 @@ import TabItem from "@theme/TabItem";
## Tooltips
:::info
Due to limitations (or not having found a way just yet) this feature only work in `zsh` and `powershell` for
Due to limitations (or not having found a way just yet), this feature only works in `ZSH` and `PowerShell` for
the time being.
:::
Tooltips are segments that are rendered as a right aligned prompt while you're typing certain keywords.
They behave similar to the other segments when it comes to how and when they are shown so you can tweak
Tooltips are segments that are rendered as a right-aligned prompt while you're typing certain keywords.
They behave similarly to the other segments when it comes to how and when they are shown so you can tweak
them to act and look like you want. The key difference is that they can be invoked using `tips` which are the
commands you are typing. Due to the possibility of the use of an alias, you can define for which keyword
the segment should be rendered.
@ -52,7 +52,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. Keep in mind that
This configuration will render a right-aligned git segment when you type `git` or `g` followed by a space. Keep in mind that
this is a blocking call, meaning that if the segment renders slow, you can't type until it's visible. Optimizations in this space
are being explored.

View file

@ -34,7 +34,7 @@ A really simple configuration could look like this.
With this configuration, a single powerline segment is rendered that shows the name of the folder you're currently in.
To set this configuration in combination with a Oh My Posh [executable][releases], use the `--config` flag to
set a path to a json file containing the above code. The `--shell universal` flag is used to print the prompt without
set a path to a JSON file containing the above code. The `--shell universal` flag is used to print the prompt without
escape characters to see the prompt as it would be shown inside a prompt function for your shell.
:::info
@ -71,8 +71,8 @@ you notice black elements in Windows Terminal or the Visual Studio Code integrat
### Console Title Template
You can create a more custom console title with the use of `"console_title_style" = "template"`.
When this is set, a `console_title_template` is also expected, otherwise the title will remain empty.
Under the hood this uses go's [text/template][go-text-template] feature extended with [sprig][sprig] and
When this is set, a `console_title_template` is also expected, otherwise, the title will remain empty.
Under the hood, this uses go's [text/template][go-text-template] feature extended with [sprig][sprig] and
offers a few standard properties to work with.
- `.Root`: `boolean` - is the current user root/admin or not
@ -126,11 +126,11 @@ Start the block on a new line. Defaults to `false`.
### Alignment
Tell the engine if the block should be left or right aligned.
Tell the engine if the block should be left or right-aligned.
### Vertical offset
Move the block up or down x lines. For example `vertical_offset: 1` moves the prompt down one line, `vertical_offset: -1`
Move the block up or down x lines. For example, `vertical_offset: 1` moves the prompt down one line, `vertical_offset: -1`
moves it up one line.
### Horizontal offset
@ -144,7 +144,7 @@ Array of one or more segments.
## Segment
A segments is a part of the prompt with a certain context. There are different types available out of the box, if you're
A segment is a part of the prompt with a certain context. There are different types available out-of-the-box, if you're
looking for what's included, feel free to skip this part and browse through the [segments][segments]. Keep reading to
understand how to configure a segment.
@ -166,7 +166,7 @@ Takes the `string` value referencing which segment logic it needs to run (see [s
### Style
Oh Hi! You made it to a really interesting part, great! Style defines how a prompt is rendered. Looking at most prompt
Oh Hi! You made it to a really interesting part, great! Style defines how a prompt is rendered. Looking at the most prompt
themes out there, we identified 3 types. All of these require a different configuration and depending on the look
you want to achieve you might need to understand/use them all.
@ -234,10 +234,10 @@ The following sample is based on the [AWS Segment][aws].
}
```
The logic is as follows, when `background_templates` contains an array, we will check every template line until there's
The logic is as follows: when `background_templates` contains an array, we will check every template line until there's
one that returns a non-empty string. So, when the contents of `.Profile` contain the word `default`, the first template
returns `#FFA400` and that's the color that will be used. If it contains `jan`, it returns `#f1184c`. When none of the
templates return a value, the foreground value `#ffffff` is used.
templates returns a value, the foreground value `#ffffff` is used.
### Background
@ -253,7 +253,7 @@ An array of **Properties** with a value. This is used inside of the segment logi
will be. Segments have the ability to define their own Properties, but there are some general ones being used by the
engine which allow you to customize the output even more.
#### General purpose properties
#### General-purpose properties
You can use these on any segment, the engine is responsible for adding them correctly.
@ -341,11 +341,11 @@ Oh My Posh mainly supports three different color types being
#### Color overrides
You have the ability to override the foreground and/or background color for text in any property that accepts it.
The syntax is custom but should be rather straighforward:
The syntax is custom but should be rather straight-forward:
`<#ffffff,#000000>this is white with black background</> <#FF479C>but this is pink</>`. Anything between the color start
`<#FF479C>` and end `</>` will be colored accordingly.
For example, if you want `prefix` to print a colored bracket which isn't the same as the segment's `foreground`, you can
For example, if you want `prefix` to print a colored bracket that isn't the same as the segment's `foreground`, you can
do so like this:
```json

View file

@ -51,7 +51,7 @@ You can use the Oh My Posh's built-in `--debug` flag to identify slow segments.
oh-my-posh --config ~/.mytheme.omp.json --debug --shell uni
```
Whenever there's a segment that spikes, see if there might be updates to the underlying functionality (usally shell commands).
Whenever there's a segment that spikes, see if there might be updates to the underlying functionality (usually shell commands).
</TabItem>
</Tabs>
@ -80,12 +80,12 @@ A temporary workaround is to use an invisible character at the end (`\u2800`).
The font you're using doesn't have the needed standard extended glyph set like [Nerd Font][nf] does.
Windows Terminal ships with Cascadia Code by default which has a powerline patched variant called Cascadia Code PL,
but also that one misses certain interesting icons. You can fall back to any theme with the `.minimal` indication,
or make use of a Nerd Font. Have a look at the [font][font] senction for more context in case you're using all the right conditions.
or make use of a Nerd Font. Have a look at the [font][font] section for more context in case you're using all the right conditions.
### Jetbrains terminals: Icons do not rendering
### Jetbrains terminals: Icons do not render
They need to work on their terminal, somehow it only supports UTF-8 and not UTF-16.
[An issue][jb-icons] is available for follow-up here.
[An issue][jb-icons] is available for a follow-up here.
### The term 'Set-Theme' is not recognized as the name of a cmdlet, function, script file, or operable program.

View file

@ -1,6 +1,6 @@
<!-- markdownlint-disable-next-line MD041 -->
At this point you're good to go. The `jandedobbeleer.omp.json` theme displays most common use-cases
in your prompt so 9/10 you'll be more than happy with it. However, if you want to explore additional
At this point, you're good to go. The `jandedobbeleer.omp.json` theme displays the most common use-cases
in your prompt, so 9/10 you'll be more than happy with it. However, if you want to explore additional
functionality, going through the additional steps below will help you get started.
#### Change the theme

View file

@ -10,7 +10,7 @@ import Customize from "./install-customize.md";
:::info
This guide is for usage inside PowerShell only. If you plan to use Oh My Posh inside other shells as well,
have a look at the platform specific install instructions.
have a look at the platform-specific install instructions.
:::
## Installation

View file

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

View file

@ -11,7 +11,7 @@ the prompt string with a function or variable.
## Oh My Posh 3 vs Oh My Posh 2
Oh My Posh 3 is the offspring of [Oh My Posh][omp], a prompt theme engine for PowerShell.
Oh My Posh started out by being inspired from tools like [oh my zsh][omz] when nothing was
Oh My Posh started out by being inspired by tools like [Oh my ZSH][omz] when nothing was
available specifically for PowerShell.
Over the years, I switched operating system/main shell quite a lot, even on

View file

@ -6,7 +6,7 @@ sidebar_label: Shell
## What
Show the current shell name (zsh, powershell, bash, ...).
Show the current shell name (ZSH, powershell, bash, ...).
## Sample Configuration

View file

@ -4,7 +4,7 @@ title: Themes
sidebar_label: 🎨 Themes
---
Oh My Posh comes with many themes included out of the box. Below are some screenshots of the more common themes.
Oh My Posh comes with many themes included out-of-the-box. Below are some screenshots of the more common themes.
For the full updated list of themes, [view the themes][themes] in Github. If you are using PowerShell, you can
display every available theme using the following PowerShell cmdlet.

View file

@ -9,7 +9,7 @@ available as a prerelease while we work out the kinks and get it on par with V2.
## V2's problem statement
V2 has Powershell module files as [themes][themesv2]. That way of working was inspired from [oh-my-zsh][omz] and other
V2 has Powershell module files as [themes][themesv2]. That way of working was inspired by [oh-my-zsh][omz] and other
prompt rendering tools, but that approach has a few important downsides.
- hard to extend/adjust when you're not proficient
@ -18,8 +18,8 @@ prompt rendering tools, but that approach has a few important downsides.
## Enter V3
This bring us to the first change, to allow a cross platform experience, [Oh My Posh V3][v3] is written entirely in [Go][golang].
That way, cross platform binaries can be shipped which render the same prompt using the same config anywhere.
This brings us to the first change, to allow a cross-platform experience, [Oh My Posh V3][v3] is written entirely in [Go][golang].
That way, cross-platform binaries can be shipped which render the same prompt using the same config anywhere.
The configuration is changed from `$ThemeSettings` towards a `.json` file that only contains the configuration for the
blocks and segments you want to render. See [concept][introduction] for more context on that part.
@ -36,7 +36,7 @@ Update-Module -Name oh-my-posh -Scope CurrentUser
## Configuration
Here we have a few options. If you're using an out-of-the box theme, you can simply change the current command to the
Here we have a few options. If you're using an out-of-the-box theme, you can simply change the current command to the
new one, provided your V2 theme has already been added to [V3][themesv3].
### I use an out-of-the-box theme