Nerd Fonts

https://www.nerdfonts.com/
Admin
Nerd Fonts patches developer-targeted fonts with thousands of glyphs from popular icon sets...
Tokens:7,522
Snippets:149
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Nerd Fonts with Homebrew

Source: https://www.nerdfonts.com/font-downloads

Use this command to install Nerd Fonts via Homebrew on macOS or Linux. Replace `<FONT NAME>` with the specific font you wish to install.

```bash
brew install --cask font-<FONT NAME>-nerd-font
```

--------------------------------

### Select Vertical Metrics Source

Source: https://www.nerdfonts.com/

In problematic cases, use the --vertical-metrics-source option to select the source for vertical metrics.

```bash
Select vertical metrics source (for problematic cases)
```

--------------------------------

### Nerd Fonts Patcher CLI Usage

Source: https://www.nerdfonts.com/

Displays the help message for the font-patcher command, outlining all available options and arguments. Use this to understand the full capabilities of the patcher.

```bash
Nerd Fonts Patcher v3.4.0-5 (4.20.3) (ff 20230101)
usage: font-patcher [--careful] [--debug [{0,1,2,3}]] [--extension EXTENSION]
                    [--help] [--makegroups [{-1,0,1,2,3,4,5,6}]] [--mono]
                    [--outputdir OUTPUTDIR] [--quiet] [--single-width-glyphs]
                    [--variable-width-glyphs] [--version] [--complete]
                    [--codicons] [--fontawesome] [--fontawesomeext]
                    [--fontlogos] [--material] [--octicons] [--pomicons]
                    [--powerline] [--powerlineextra] [--powersymbols]
                    [--weather] [--adjust-line-height] [--boxdrawing]
                    [--cell CELLOPT] [--configfile CONFIGFILE]
                    [--custom CUSTOM] [--dry] [--glyphdir GLYPHDIR]
                    [--has-no-italic] [--metrics {HHEA,TYPO,WIN}]
                    [--name FORCE_NAME] [--postprocess POSTPROCESS]
                    [--removeligs] [--xavgcharwidth [XAVGWIDTH]]
                    [--progressbars | --no-progressbars]
                    font

Nerd Fonts Font Patcher: patches a given font with programming and development related glyphs

* Website: https://www.nerdfonts.com
* Version: 3.4.0-5
* Development Website: https://github.com/ryanoasis/nerd-fonts
* Changelog: https://github.com/ryanoasis/nerd-fonts/blob/-/changelog.md

positional arguments:
  font                  The path to the font to patch (e.g., Inconsolata.otf)

options:
  --careful             Do not overwrite existing glyphs if detected
  --debug [{0,1,2,3}]   Verbose mode (optional: 1=just to file; 2*=just to terminal; 3=display and file)
  --extension EXTENSION, -ext EXTENSION
                        Change font file type to create (e.g., ttf, otf)
  --help, -h            Show this help message and exit
  --makegroups [{-1,0,1,2,3,4,5,6}]
                        Use alternative method to name patched fonts (default=1)
  --mono, -s            Create monospaced font, existing and added glyphs are single-width (implies --single-width-glyphs)
  --outputdir OUTPUTDIR, -out OUTPUTDIR
                        The directory to output the patched font file to
  --quiet, -q           Do not generate verbose output
  --single-width-glyphs
                        Whether to generate the glyphs as single-width not double-width (default is double-width) (Nerd Font Mono)
  --variable-width-glyphs
                        Do not adjust advance width (no "overhang") (Nerd Font Propo)
  --version, -v         Show program's version number and exit

Symbol Fonts:
  --complete, -c        Add all available Glyphs
  --codicons            Add Codicons Glyphs (https://github.com/microsoft/vscode-codicons)
  --fontawesome         Add Font Awesome Glyphs (http://fontawesome.io/)
  --fontawesomeext      Add Font Awesome Extension Glyphs (https://andrelzgava.github.io/font-awesome-extension/)
  --fontlogos           Add Font Logos Glyphs (https://github.com/Lukas-W/font-logos)
  --material, --mdi     Add Material Design Icons (https://github.com/templarian/MaterialDesign)
  --octicons            Add Octicons Glyphs (https://octicons.github.com)
  --pomicons            Add Pomicon Glyphs (https://github.com/gabrielelana/pomicons)
  --powerline           Add Powerline Glyphs
  --powerlineextra      Add Powerline Extra Glyphs (https://github.com/ryanoasis/powerline-extra-symbols)
  --powersymbols        Add IEC Power Symbols (https://unicodepowersymbol.com/)
  --weather             Add Weather Icons (https://github.com/erikflowers/weather-icons)

Expert Options:
  --adjust-line-height, -l
                        Whether to adjust line heights (attempt to center powerline separators more evenly)
  --boxdrawing          Force patching in (over existing) box drawing glyphs
  --cell CELLOPT        Adjust or query the cell size, e.g. use "0:1000:-200:800" or "?"
  --configfile CONFIGFILE
                        Specify a file path for configuration file (see sample: src/config.sample.cfg)
  --custom CUSTOM       Specify a custom symbol font, all glyphs will be copied; absolute path suggested
  --dry                 Do neither patch nor store the font, to check naming
  --glyphdir GLYPHDIR   Path to glyphs to be used for patching
  --has-no-italic       Font family does not have Italic (but Oblique), to help create correct RIBBI set
  --metrics {HHEA,TYPO,WIN}

```

--------------------------------

### Specify Post-Processing Script

Source: https://www.nerdfonts.com/

The --postprocess option allows you to specify a script for post-processing the patched font.

```bash
--postprocess POSTPROCESS                        Specify a Script for Post Processing
```

--------------------------------

### Enable Progress Bars for Patching

Source: https://www.nerdfonts.com/

The --progressbars flag enables the display of percentage completion progress bars for each Glyph Set during the patching process.

```bash
--progressbars        Show percentage completion progress bars per Glyph Set (default)
```

--------------------------------

### Specify Naming Source for Patched Fonts

Source: https://www.nerdfonts.com/

Use the --name option to control how the patched font is named. Options include 'full', 'postscript', or 'filename'. You can also provide a concrete name string.

```bash
--name FORCE_NAME     Specify naming source ('full', 'postscript', 'filename', or concrete free name-string)
```

--------------------------------

### Disable Progress Bars for Patching

Source: https://www.nerdfonts.com/

Use --no-progressbars to disable the display of percentage completion progress bars for Glyph Sets.

```bash
--no-progressbars     Don't show percentage completion progress bars per Glyph Set
```

--------------------------------

### Adjust X Average Character Width

Source: https://www.nerdfonts.com/

The --xavgcharwidth option adjusts the xAvgCharWidth. An optional concrete value can be provided.

```bash
--xavgcharwidth [XAVGWIDTH]                        Adjust xAvgCharWidth (optional: concrete value)
```

--------------------------------

### Import Nerd Fonts CSS

Source: https://www.nerdfonts.com/cheat-sheet

Import the Nerd Fonts webfont CSS to use the icons on a webpage. This is typically placed in your main CSS file or included via a link tag.

```css
@import "https://www.nerdfonts.com/assets/css/webfont.css"
```

--------------------------------

### Remove Ligatures from Patched Fonts

Source: https://www.nerdfonts.com/

Use --removeligs or --removeligatures along with --configfile to remove ligatures specified in a configuration file.

```bash
--removeligs, --removeligatures                        Removes ligatures specified in configuration file (needs --configfile)
```

--------------------------------

### Use Nerd Fonts Icons in HTML

Source: https://www.nerdfonts.com/cheat-sheet

Embed Nerd Fonts icons directly into your HTML using the 'nf' class prefix followed by the icon identifier. Ensure the webfont CSS is imported.

```html
I really <i class="nf nf-fa-heart"></i> <i class="nf nf-custom-vim"></i>
```
Tokens:
Raw