mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2025-01-28 03:21:26 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: adjust font installation instructions

Browse source
This commit is contained in:
craftzneko 2023-03-08 09:27:45 +00:00 committed by Jan De Dobbeleer
parent 14f7a9318f
commit 536dcf334f
1 changed files with 24 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
website/docs/installation/fonts.mdx
View file

@ -14,7 +14,7 @@ We recommend [Meslo LGM NF][meslo], but any Nerd Font should be compatible with
To see the icons displayed in Oh My Posh, **install** a [Nerd Font][nerdfonts], and **configure** your terminal to use it. To see the icons displayed in Oh My Posh, **install** a [Nerd Font][nerdfonts], and **configure** your terminal to use it.
#### Installation ### Installation
<Tabs <Tabs
defaultValue="oh-my-posh" defaultValue="oh-my-posh"
@ -51,7 +51,23 @@ brew install --cask font-fira-code-nerd-font
</TabItem> </TabItem>
</Tabs> </Tabs>
#### Windows Terminal ### Configuration
Make sure to **configure your terminal** to use the font you have installed. The following sections will show you how to do this for the most popular terminals.
<Tabs
defaultValue="wt"
values={[
{ label: 'Windows Terminal', value: 'wt' },
{ label: 'VS Code', value: 'code' }
]
}>
<TabItem value="wt">
:::caution Text renderer
To ensure correct rendering of the glyphs you will need to enable the option `Use the new text renderer ("AtlasEngine")` in your terminal settings.
For further details, see [here][wt-issue-8993].
:::
Once you have installed a Nerd Font, you will need to configure the Windows Terminal to use it. This can be easily done Once you have installed a Nerd Font, you will need to configure the Windows Terminal to use it. This can be easily done
by modifying the Windows Terminal settings (default shortcut: `CTRL + SHIFT + ,`). In your `settings.json` file, add the by modifying the Windows Terminal settings (default shortcut: `CTRL + SHIFT + ,`). In your `settings.json` file, add the
@ -72,7 +88,8 @@ by modifying the Windows Terminal settings (default shortcut: `CTRL + SHIFT + ,`
} }
``` ```
#### VS Code </TabItem>
<TabItem value="code">
When using Visual Studio Code, you will need to configure the integrated Terminal to make use of the Nerd Font as well. This can be done by changing the `Integrated: Font Family` value in the Terminal settings (default shortcut: `CTRL + ,` and search for `Integrated: Font Family` or via `Users` -> `Features` -> `Terminal`). When using Visual Studio Code, you will need to configure the integrated Terminal to make use of the Nerd Font as well. This can be done by changing the `Integrated: Font Family` value in the Terminal settings (default shortcut: `CTRL + ,` and search for `Integrated: Font Family` or via `Users` -> `Features` -> `Terminal`).
@ -82,6 +99,9 @@ If you are using the JSON based settings, you will need to update the `terminal.
"terminal.integrated.fontFamily": "MesloLGM NF" "terminal.integrated.fontFamily": "MesloLGM NF"
``` ```
</TabItem>
</Tabs>
### Other Fonts ### Other Fonts
If you are not interested in using a Nerd Font, you will want to use a theme which doesn't include any Nerd Font icons. If you are not interested in using a Nerd Font, you will want to use a theme which doesn't include any Nerd Font icons.
@ -94,3 +114,4 @@ The `minimal` themes do not make use of Nerd Font icons.
[themes]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/themes [themes]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/themes
[font-thread]: https://github.com/JanDeDobbeleer/oh-my-posh/issues/145#issuecomment-730162622 [font-thread]: https://github.com/JanDeDobbeleer/oh-my-posh/issues/145#issuecomment-730162622
[configuration]: /docs/configuration/overview [configuration]: /docs/configuration/overview
[wt-issue-8993]: https://github.com/microsoft/terminal/issues/8993