From 536dcf334f50fba1f10e9628677cdef3663414ca Mon Sep 17 00:00:00 2001 From: craftzneko <662108+craftzneko@users.noreply.github.com> Date: Wed, 8 Mar 2023 09:27:45 +0000 Subject: [PATCH] docs: adjust font installation instructions --- website/docs/installation/fonts.mdx | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/website/docs/installation/fonts.mdx b/website/docs/installation/fonts.mdx index 0312f03b..514ee023 100644 --- a/website/docs/installation/fonts.mdx +++ b/website/docs/installation/fonts.mdx @@ -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. -#### Installation +### Installation -#### 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. + + + + +:::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 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 + + 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" ``` + + + ### 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. @@ -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 [font-thread]: https://github.com/JanDeDobbeleer/oh-my-posh/issues/145#issuecomment-730162622 [configuration]: /docs/configuration/overview +[wt-issue-8993]: https://github.com/microsoft/terminal/issues/8993