chore: homebrew documentation

This commit is contained in:
Jan De Dobbeleer 2020-11-07 19:50:33 +01:00 committed by Jan De Dobbeleer
parent 05aa236f36
commit 49570c0aaa
3 changed files with 48 additions and 1 deletions

View file

@ -77,6 +77,10 @@ Invoke-Webrequest https://github.com/JanDeDobbeleer/oh-my-posh3/releases/latest/
</TabItem> </TabItem>
<TabItem value="macos"> <TabItem value="macos">
#### Homebrew
A [Homebrew][brew] package is available to assist installs on MacOS.
#### Manual #### Manual
```bash ```bash
@ -127,6 +131,10 @@ Remove-Item C:\tools\poshthemes\themes.zip
</TabItem> </TabItem>
<TabItem value="macos"> <TabItem value="macos">
#### Homebrew
When using [Homebrew][brew], all themes are downloaded as well.
#### Manual #### Manual
```bash ```bash
@ -366,5 +374,6 @@ oh-my-posh -config ~/.mytheme.json
[powershell]: /docs/powershell [powershell]: /docs/powershell
[themes]: https://github.com/JanDeDobbeleer/oh-my-posh3/tree/main/themes [themes]: https://github.com/JanDeDobbeleer/oh-my-posh3/tree/main/themes
[scoop]: /docs/scoop [scoop]: /docs/scoop
[brew]: /docs/homebrew
[prompt]: /docs/installation#4-replace-your-existing-prompt [prompt]: /docs/installation#4-replace-your-existing-prompt
[configuration]: /docs/configure [configuration]: /docs/configure

View file

@ -0,0 +1,38 @@
---
id: homebrew
title: Homebrew
sidebar_label: Homebrew
---
A package that installs the Oh my Posh executable using [Homebrew][brew].
:::caution Font icons
For maximum enjoyment, make sure to **install** and **configure** your terminal to use a powerline enabled font.
The fonts we use are patched by [Nerd Fonts][nerdfonts], which offer a maximum of icons you can use to configure your prompt.
To easily find the icon you want, have a look at their [cheat sheet][nf-cheat].
:::
## Installation
```bash
brew tap jandedobbeleer/oh-my-posh
brew install oh-my-posh
```
This installs two things:
- `oh-my-posh` - Executable, added to `/usr/local/bin`
- `themes` - The latest Oh my Posh themes
If you want to use a standard theme, you can find them in `$(brew --prefix oh-my-posh)/themes`, referencing them as such
will always keep them compatible with the binary when updating Oh my Posh.
## Update
```bash
brew upgrade oh-my-posh
```
[brew]: https://brew.sh/
[nerdfonts]: https://www.nerdfonts.com/
[nf-cheat]: https://www.nerdfonts.com/cheat-sheet

View file

@ -8,7 +8,7 @@ module.exports = {
{ {
type: "category", type: "category",
label: "Packages", label: "Packages",
items: ["powershell", "scoop"], items: ["powershell", "scoop", "homebrew"],
}, },
{ {
type: "category", type: "category",