🔡 Iconic font aggregator, collection, and patcher. 40+ patched fonts, over 3,600 glyph/icons, includes popular collections such as Font Awesome & fonts such as Hack
Clone or download
ryanoasis Update readme.md
- Small grammar fixes
- Add mentions of Operator Mono and Dank Mono
Latest commit d1d9a7e Apr 29, 2018
Permalink
Failed to load latest commit information.
.github Improves template with emoji and commented out lines Nov 5, 2017
bin/scripts Fixes to pattern and case sensitivity Apr 1, 2018
css Rebuilds CSS with fixed Weather codepoints (WIP #247) Mar 24, 2018
images Updates font size and ran scour Apr 8, 2018
patched-fonts Merge pull request #253 from romen/nerdplex Apr 10, 2018
src Reattaches missing eye to Python (#249) Apr 22, 2018
.all-contributorsrc Updates 'all contributors' information Apr 8, 2018
.gitignore Ignores node modules folder Nov 18, 2017
.travis.yml Update .travis.yml Apr 22, 2018
10-nerd-font-symbols.conf Updates fontconfig with latest updates in v2.0.0 Mar 18, 2018
CONTRIBUTORS.md Updates 'all contributors' information Apr 8, 2018
LICENSE Update LICENSE Mar 2, 2017
changelog.md Updates changelog with missing info (v2.0.0) Apr 1, 2018
code_of_conduct.md fixed links Jul 28, 2017
contributing.md Update contributing.md Dec 8, 2017
font-patcher Rename the patched font as 'Blex' Apr 3, 2018
install.sh Treats fc-cache return code of 1 as success prevent install.sh return… Jan 13, 2018
package.json Bumps project version numbers of scripts for v1.2.0 release Nov 18, 2017
readme.md Update readme.md Apr 29, 2018
readme_cn.md Updates font combinations and variations counts Nov 18, 2017
readme_fr.md Fix font table relative urls Apr 21, 2018
readme_ru.md Updates font combinations and variations counts Nov 18, 2017
readme_tw.md Add readme of zh-tw version for issue #118 Dec 10, 2017

readme.md

Nerd Fonts Logo

Iconic font aggregator, collection, and patcher

Releases   |   Fonts   |   Font Patcher   |   Wiki Documentation   |   Stickers   |   VimDevIcons

GitHub release Gitter CodeClimate Build Status Code of Conduct PRs Welcome Nerd Fonts - OS Support Twitter

Nerd Fonts is a project that patches developer targeted fonts with a high number of glyphs (icons). Specifically to add a high number of extra glyphs from popular 'iconic fonts' such as Font Awesome ➶, Devicons ➶, Octicons ➶, and others.

The following Sankey flow diagram shows the current glyph sets included:

@SankeyMATIC Diagram

Diagram created using @SankeyMATIC

Important Notices

Table of Contents

TL;DR

Installation Options

Features

Developer / Contributor

Project Motivation

Additional Info

TL;DR

Nerd Fonts takes popular programming fonts and adds a bunch of Glyphs. There is also a font patcher available if your desired font isn't already patched. For more high level information see the wiki. If you are looking for the Vim plugin see VimDevIcons ➶.

Various Download Options for Fonts

If you...

Features

Glyph Sets

🔍 🔍 You can now search for glyphs easily on NerdFonts.com via the Cheat Sheet

Seti-UI + Custom

Based off of Seti-UI Icomoon with extra custom glyphs.

🔍 📑 See set on the NerdFonts.com Website

Devicons

An iconic font made for developers, code jedis, ninjas, HTTPsters, evangelists and nerds(sic). / (repo) / (website)

🔍 📑 See set on the NerdFonts.com Website

Font Awesome

The iconic font and CSS toolkit. / (repo) / (website)

🔍 📑 See set on the NerdFonts.com Website

Font Awesome Extension

Simple Font Awesome Extension. / (repo) / (website)

🔍 📑 See set on the NerdFonts.com Website

Material Design Icons

2000+ Material Design Icons from the Community. / (repo) / (website)

🔍 📑 See set on the NerdFonts.com Website

Weather

215 Weather Themed Icons and CSS. / (repo) / (website)

🔍 📑 See set on the NerdFonts.com Website

Octicons

GitHub's icons. / (repo) / (website)

🔍 📑 See set on the NerdFonts.com Website*

* To avoid conflicts between icon sets, these were modified in the 'Complete' fonts. To view the original codepoints see the Wiki.

Powerline Extra Symbols

Provides extra Powerline separator glyphs and a column number glyph (CN). / (repo)

🔍 📑 See set on the NerdFonts.com Website

IEC Power Symbols

Adding new characters into Unicode / (website)

🔍 📑 See set on the NerdFonts.com Website

Font Logos (Formerly Font Linux)

Font-logos is an icon font containing logos of popular linux distributions and other open source software for inclusion in websites. / (repo)

🔍 📑 See set on the NerdFonts.com Website

Pomicons

8 symbols for the "Pomodoro Technique"®. / (repo)

🔍 📑 See set on the NerdFonts.com Website

Icon names in shell

Download provided .sh files from bin/scripts/lib/ directory somewhere, recommended locations are ~/.local/share/fonts/ or ~/bin/.

  • i_all.sh - helper to load all files you've downloaded at once
  • i_dev.sh - Devicons (198 icons, 8 does not have an established name)
  • i_fa.sh - Font Awesome (675 icons, 111 aliases)
  • i_fae.sh - Font Awesome Extension (170 icons)
  • i_iec.sh - IEC Power Symbols (5 icons)
  • i_linux.sh - Font Linux (20 icons)
  • i_oct.sh - Octicons (172 icons)
  • i_ple.sh - Powerline Extra Symbols (37 icons, 2 aliases, 16 does not have an established name)
  • i_pom.sh - Pomicons (11 icons)
  • i_seti.sh - Seti-UI + Custom (50 icons, 2 aliases, 5 does not have an established name)

Then source the required file(s) and output $i_* variables to see icons:

source ~/.local/share/fonts/i_oct.sh
echo $i_oct_heart
# Output:
# ♥

NOTE: You have to use one of the Nerd Fonts to see correct icons for some icon sets (Devicons, Font Awesome Extension, Font Linux), but other sets should work with their standard fonts too.

Patched Fonts

Font Name Font Name and Repository *RFN EM Size Status
3270 Nerd Font 3270 NO 1000 w m2 l
Anonymice Nerd Font Anonymous Pro NO 2048 w m2 l
Arimo Arimo NO 2048 w m2 l
Aurulent Sans Mono Nerd Font NO 1000 w m2 l
BigBlueTerminal NO 1200 w m2 l
Bitstream Vera Sans Mono Nerd Font NO 2048 w m2 l
Blex* IBM Plex YES 1000 w m2 l
Code New Roman Nerd Font NO 2048 w m2 l
Cousine Nerd Font Cousine NO 1000 w m2 l
DejaVu Sans Mono Nerd Font NO 2048 w m2 l
Droid Sans Mono Nerd Font NO 2048 w m2 l
Fantasque Sans Nerd Font Fantasque Sans NO 2048 w m2 l
Fura Code Nerd Font* Fira YES 1000 w m2 l
Fura Mono Nerd Font* Fira YES 1000 w m2 l
Go Mono Nerd Font Go-Mono NO 1000 w m2 l
Gohu Nerd Font Gohu TTF,Gohu NO 1000 w m2 l
Hack Nerd Font Hack NO 2048 w m2 l
Hasklug Nerd Font* Hasklig YES 1000 w m2 l
Heavy Data Mono Nerd Font NO 2048 w m2 l
Hermut Nerd Font NO 1000 w m2 l
Inconsolata Nerd Font NO 1000 w m2 l
Inconsolata Go Nerd Font NO 1000 w m2 l
Inconsolata LGC Nerd Font NO 1000 w m2 l
Iosevka Nerd Font Iosevka YES 1000 #83
Lekton Nerd Font NO 1000 w m2 l
Literation Mono Nerd Font Liberation YES 2048 w m2 l
Meslo Nerd Font NO 2048 w m2 l
Monofur Nerd Font NO 2400 w m2 l
Monoid Nerd Font NO 1536 w m2 l
Mononoki Nerd Font Mononoki NO 1024 w m2 l
M+ (MPlus) Nerd Font NO 1000 w m2 l
Noto NO 1000 w m2 l
OpenDyslexic NO 1000 w m2 l
Overpass NO 1000 w m2 l
ProFont (Windows tweaked) Nerd Font NO 1200 w m2 l
ProFont (x11) Nerd Font NO 1000 w m2 l
ProggyClean Nerd Font NO 2048 Imperfect
Roboto Mono NO 2048 w m2 l
Sauce Code Nerd Font Source YES 1000 w m2 l
Shure Tech Mono Nerd Font* Share Tech Mono YES 1000 w m2 l
Space Mono Nerd Font Space Mono NO 1000 w m2 l
Terminess Nerd Font* Terminus Font YES 1000 w m2 l
Tinos YES 2048 w m2 l
Ubuntu Nerd Font NO 1000 w m2 l
Ubuntu Mono Nerd Font NO 1000 w m2 l

*RFN = Reserved Font Name

Combinations

  • Over 1,200,000 unique variations/combinations (Power Set) of patched fonts:
    • 44 patched font typefaces
    • 612 patched font families
    • 2,448 'complete' variations/combinations
    • 1,264,440 possible variations/combinations
    • 1,266,888 total calculated combinations (2,448 + 1,264,440)
  • Combinations for each font are any combination of Variations

Variations

Font Installation

Option 1: Download and Install Manually

Best option for quickly getting a specific individual font.

Download the specific patched font of your choice

Option 2: Release Archive Download

Best option if you want an archive or complete font family of variations (Bold, Italic, etc.).

Fonts are available for download as packages in the latest release

Option 3: Install Script

Best option if you want to automate installing or for use in scripts.

Note: Only for Linux & macOS (OS X) Note: Requires cloning the repo as of now

All fonts:

  • Installs all the patched Fonts (Warning: This is a lot of Fonts adding up to a large size)
./install.sh

Single font:

  • Installs a single Font of your choice
./install.sh <FontName>
./install.sh Hack
./install.sh HeavyData

Option 4: Homebrew Fonts

Best option if on macOS and want to use Homebrew.

All fonts are available via Homebrew Fonts on macOS (OS X)

brew tap caskroom/fonts
brew cask install font-hack-nerd-font

Option 5: Clone the Repo

Best option for full control, all or most of the fonts, or contributing to development.

Cloning of this repository is not required nor efficient if you are simply only interested in a limited set of fonts.

However if you do want to clone the repo be sure to shallow clone:

git clone --depth 1

Option 6: Ad Hoc Curl Download

Option if you want to use the curl command or for use in scripts.

Linux

mkdir -p ~/.local/share/fonts
cd ~/.local/share/fonts && curl -fLo "Droid Sans Mono for Powerline Nerd Font Complete.otf" https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/DroidSansMono/complete/Droid%20Sans%20Mono%20Nerd%20Font%20Complete.otf

Note: deprecated alternative paths: ~/.fonts

macOS (OS X)

cd ~/Library/Fonts && curl -fLo "Droid Sans Mono for Powerline Nerd Font Complete.otf" https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/DroidSansMono/complete/Droid%20Sans%20Mono%20Nerd%20Font%20Complete.otf

Option 7: Unofficial Arch User Repository (AUR)

Option for Arch Linux and wanting to use AUR packages.

The following fonts are available via AUR packages on Arch Linux:

Option 8: Patch Your Own Font

The option for patching your own font or fully customizing the patched font.

Use the provided Python command line script to generate a patched font from your own font to get the extra new glyphs

See: Font Patcher for usage

  • use this option if you do not want to use one of the fonts provided
  • you will still need to copy the generated font to the correct font directory on your system

Nerd Fonts Patcher

Patching the font of your own choosing for use with the VimDevIcons ➶:

  • requires: Python 2 (or Python 3), python-fontforge package (version 20141231 or later, see the install instructions)
  • alternative install method on OSX: brew install fontforge
  • Usage:
./font-patcher PATH_TO_FONT
  • Alternative usage: Execute the patcher with the FontForge binary using the script flag:
./fontforge -script font-patcher PATH_TO_FONT
usage: font-patcher [-h] [-v] [-s] [-l] [-q] [-w] [-c] [--fontawesome]
                    [--fontawesomeextension] [--fontlinux] [--octicons]
                    [--powersymbols] [--pomicons] [--powerline]
                    [--powerlineextra] [--material] [--weather]
                    [--custom [CUSTOM]] [--postprocess [POSTPROCESS]]
                    [--removeligs] [--configfile [CONFIGFILE]]
                    [--progressbars | --no-progressbars] [--careful]
                    [-ext [EXTENSION]] [-out [OUTPUTDIR]]
                    font

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

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

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

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -s, --mono, --use-single-width-glyphs
                        Whether to generate the glyphs as single-width not double-width (default is double-width)
  -l, --adjust-line-height
                        Whether to adjust line heights (attempt to center powerline separators more evenly)
  -q, --quiet, --shutup
                        Do not generate verbose output
  -w, --windows         Limit the internal font name to 31 characters (for Windows compatibility)
  -c, --complete        Add all available Glyphs
  --fontawesome         Add Font Awesome Glyphs (http://fontawesome.io/)
  --fontawesomeextension
                        Add Font Awesome Extension Glyphs (https://andrelzgava.github.io/font-awesome-extension/)
  --fontlinux, --fontlogos
                        Add Font Linux and other open source Glyphs (https://github.com/Lukas-W/font-logos)
  --octicons            Add Octicons Glyphs (https://octicons.github.com)
  --powersymbols        Add IEC Power Symbols (https://unicodepowersymbol.com/)
  --pomicons            Add Pomicon Glyphs (https://github.com/gabrielelana/pomicons)
  --powerline           Add Powerline Glyphs
  --powerlineextra      Add Powerline Glyphs (https://github.com/ryanoasis/powerline-extra-symbols)
  --material, --materialdesignicons, --mdi
                        Add Material Design Icons (https://github.com/templarian/MaterialDesign)
  --weather, --weathericons
                        Add Weather Icons (https://github.com/erikflowers/weather-icons)
  --custom [CUSTOM]     Specify a custom symbol font. All new glyphs will be copied, with no scaling applied.
  --postprocess [POSTPROCESS]
                        Specify a Script for Post Processing
  --removeligs, --removeligatures
                        Removes ligatures specificed in JSON configuration file
  --configfile [CONFIGFILE]
                        Specify a file path for JSON configuration file (see sample: src/config.sample.json)
  --progressbars        Show percentage completion progress bars per Glyph Set
  --no-progressbars     Don't show percentage completion progress bars per Glyph Set
  --careful             Do not overwrite existing glyphs if detected
  -ext [EXTENSION], --extension [EXTENSION]
                        Change font file type to create (e.g., ttf, otf)
  -out [OUTPUTDIR], --outputdir [OUTPUTDIR]
                        The directory to output the patched font file to

Examples

./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf -s -q
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf --use-single-width-glyphs --quiet
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf -w
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf --windows --quiet
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf --windows --pomicons --quiet
./font-patcher Inconsolata.otf --fontawesome
./font-patcher Inconsolata.otf --fontawesome --octicons --pomicons
./font-patcher Inconsolata.otf

Gotta Patch 'em All Font Patcher!

  • for Contributor or Developer use

  • re-patches all fonts in the unpatched directory:

./gotta-patch-em-all-font-patcher\!.sh
  • can optionally limit to specific font name pattern:
./gotta-patch-em-all-font-patcher\!.sh Hermit

Contributing

See contributing.md

Unstable File Paths

⚠️ Warning: File paths may change based on releases (especially major version bumps)

Reference the release branch and not the master branch because paths are subject to change for each release

  • For example:
    • ✅ Use: https://github.com/ryanoasis/nerd-fonts/blob/0.9.0/patched-fonts/Hermit/Medium/complete/Hurmit%20Medium%20Nerd%20Font%20Complete.otf
    • ❌ Instead of: https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/Hermit/Medium/complete/Hurmit%20Medium%20Nerd%20Font%20Complete.otf

Other Good Fonts to Patch

  • a list of additional good fonts to patch that cannot be provided or shared due to the license:
  • Input Mono (license restriction)
    • Possibly coming with external hosting :)
  • PragmataPro (not free)
  • Consolas (proprietary)
  • Operator Mono (not free)
  • Dank Mono (not free)

Project Motivation

See Wiki: Project Purpose

Changelog

See changelog.md

License

MIT © Ryan L McIntyre