Skip to content

Commit 9476931

Browse files
tradiffJanDeDobbeleer
authored andcommitted
docs: move fonts to its own page
1 parent c77297c commit 9476931

File tree

3 files changed

+48
-34
lines changed

3 files changed

+48
-34
lines changed

docs/docs/fonts.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
id: fonts
3+
title: Fonts
4+
sidebar_label: 🆎 Fonts
5+
---
6+
7+
### Nerd Fonts
8+
9+
Oh my Posh was designed to use [Nerd Fonts][nerdfonts]. Nerd Fonts are popular fonts that are patched to include icons.
10+
We recommend [Meslo LGM NF][meslo], but any Nerd Font should be compatible with the standard [themes][themes].
11+
12+
To see the icons displayed in Oh my Posh, **install** a [Nerd Font][nerdfonts], and **configure** your terminal to use it.
13+
14+
#### Windows
15+
16+
Download your chosen Nerd Font, and install the font system-wide. See this [thread][font-thread] for more context.
17+
18+
#### Windows Terminal
19+
20+
Once you have installed a Nerd Font, you will need to configure the Windows Terminal to use it. This can be easily done
21+
by modifying the Windows Terminal settings (default shortcut: `CTRL + ,`). In your `settings.json` file, add the
22+
`fontFace` attribute under the `defaults` attribute in `profiles`:
23+
24+
```json
25+
{
26+
"profiles":
27+
{
28+
"defaults":
29+
{
30+
"fontFace": "MesloLGM NF"
31+
}
32+
}
33+
}
34+
```
35+
36+
### Other Fonts
37+
38+
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.
39+
The `minimal` themes do not make use of Nerd Font icons.
40+
41+
[Creating your own theme][configuration] is always an option too 😊
42+
43+
[nerdfonts]: https://www.nerdfonts.com/
44+
[meslo]: https://github.com/ryanoasis/nerd-fonts/releases/download/v2.1.0/Meslo.zip
45+
[themes]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/themes
46+
[font-thread]: https://github.com/JanDeDobbeleer/oh-my-posh/issues/145#issuecomment-730162622
47+
[configuration]: /docs/configure

docs/docs/installation.mdx

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -43,33 +43,6 @@ but you may have to set the environment variable `$TERM` to `xterm-256color` for
4343
</TabItem>
4444
</Tabs>
4545

46-
#### Font
47-
48-
To see the icons displayed in Oh my Posh, **install** and **configure** your terminal to use a powerline enabled font.
49-
The fonts we use are patched by [Nerd Fonts][nerdfonts], which offer a maximum of icons you can use.
50-
51-
Oh my Posh was designed using [Meslo LGM NF][meslo], but any Nerd Font should be compatible with the standard [themes][themes].
52-
53-
:::caution Windows fonts
54-
Make sure to install fonts system wide to avoid seeing rectangles in your terminal. See this [thread][font-thread] for more context.
55-
:::
56-
57-
:::caution Setting the default font in the Windows Terminal
58-
Once you have installed a powerline enabled font, don't forget to tell the Windows Terminal to use it. This can be easily done by modifying the Windows Terminal settings (default shortcut: `CTRL + ,`). In your `settings.json` file, add the `fontFace` attribute under the `defaults` attribute in `profiles`:
59-
60-
```json
61-
{
62-
"profiles":
63-
{
64-
"defaults":
65-
{
66-
"fontFace": "MesloLGL Nerd Font"
67-
}
68-
}
69-
}
70-
```
71-
:::
72-
7346
### 2. Install Oh my Posh
7447

7548
<Tabs
@@ -475,13 +448,7 @@ oh-my-posh --config ~/.mytheme.omp.json
475448
[scoop]: https://scoop.sh/
476449
[wt]: https://github.com/microsoft/terminal
477450
[iterm2]: https://www.iterm2.com/
478-
[nerdfonts]: https://www.nerdfonts.com/
479-
[nf-cheat]: https://www.nerdfonts.com/cheat-sheet
480-
[meslo]: https://github.com/ryanoasis/nerd-fonts/releases/download/v2.1.0/Meslo.zip
481-
[font-thread]: https://github.com/JanDeDobbeleer/oh-my-posh/issues/145#issuecomment-730162622
482451
[powershell]: https://www.powershellgallery.com/packages/oh-my-posh
483-
[themes]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/themes
484-
[scoop]: https://scoop.sh
485452
[brew]: https://brew.sh
486453
[prompt]: /docs/installation#3-replace-your-existing-prompt
487454
[configuration]: /docs/configure

docs/sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ module.exports = {
33
{
44
type: "category",
55
label: "Getting Started",
6-
items: ["introduction", "upgrading", "installation", "configure", "themes"],
6+
items: ["introduction", "upgrading", "installation", "configure", "themes", "fonts"],
77
},
88
{
99
type: "category",

0 commit comments

Comments
 (0)