| .github | ||
| bin/scripts | ||
| images | ||
| patched-fonts | ||
| src | ||
| .gitignore | ||
| 10-nerd-font-symbols.conf | ||
| changelog.md | ||
| code_of_conduct.md | ||
| contributing.md | ||
| font-patcher | ||
| font-patcher-py3 | ||
| install.sh | ||
| LICENSE | ||
| readme.md | ||
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:
Quick Links
| Fonts | Patcher | VimDevIcons ➶ |
|---|---|---|
 |
 |
 |
Important Notices
masterbranch file paths are not considered stable. Verify your repository URI references- cloning this repository is not recommended unless you are going to be contributing to development
Table of Contents
- 1 - Install Script
- 2 - Ad Hoc Curl Download
- 3 - Release Archive Download
- 4 - Homebrew Fonts (macOS (OS X))
- 5 - Manual
- 6 - Clone Repo
- 7 - Patch Your Own Font
Additional Info
Features
- A FontForge python script to patch any font
- 26 already patched font families
- Over 5,700 unique combinations/variations of patched fonts (more details)
- Over 1,000 glyphs/icons combined (more details)
- Current glyph sets include: Powerline with Extra Symbols, Font Awesome, Devicons, Octicons, Font Linux, Pomicons
- A Developer/Contributor provided bash script to re-patch all the fonts
Glyph Sets
Seti-UI + Custom
Based off of Seti-UI Icomoon with extra custom glyphs.
Devicons
An iconic font made for developers, code jedis, ninjas, HTTPsters, evangelists and nerds(sic). / (repo) / (website)
Font Awesome
Font Awesome Extension
Octicons
Powerline Extra Symbols
Provides extra Powerline separator glyphs and a column number glyph (CN). / (repo)
IEC Power Symbols
Adding new characters into Unicode / (website)
Font Linux
Font-linux is an icon font containing logos of popular linux distributions for inclusion in websites. / (repo)
Pomicons
8 symbols for the "Pomodoro Technique"®. / (repo)
Patched Fonts
*RFN = Reserved Font Name
Combinations
- Over
5,700unique variations/combinations (Power Set) of patched fonts: 102unpatched font variations (otf and ttf)56combinations- Calculated combinations
(56 * 102) = 5,712 - Combinations for each font are any combination of (plus no flags option) Variations
Variations
- no flags given (defaults to only Seti-UI and Devicons)
- double (variable/proportional) or single (fixed/monospaced) width icons/glyphs
- Font Awesome
- Font Awesome Extension
- GitHub Octicons
- Font Linux
- Powerline Extra Symbols
- IEC Power Symbols
- Pomicons
- Windows Compatibility
Font Installation
Option 1: Install Script
Note: only for Linux & macOS (OS X)
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 2: Ad Hoc Curl Download
Linux
mkdir -p ~/.local/share/fonts
cd ~/.local/share/fonts && curl -fLo "Droid Sans Mono for Powerline Nerd Font Complete.otf" https://raw.githubusercontent.com/ryanoasis/nerd-fonts/master/patched-fonts/DroidSansMono/complete/Droid%20Sans%20Mono%20for%20Powerline%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://raw.githubusercontent.com/ryanoasis/nerd-fonts/master/patched-fonts/DroidSansMono/complete/Droid%20Sans%20Mono%20for%20Powerline%20Nerd%20Font%20Complete.otf
Option 3: Release Archive Download
Coming soon
Option 4: Homebrew Fonts
Note: macOS (OS X) only
Coming soon
Option 5: Download and Install Manually
Download the specific patched font of your choice
Option 6: Clone the Repo
Cloning of this repository is not required nor the most efficient way to get the fonts, however if you want all the fonts and want to clone be sure to shallow clone:
git clone --depth 1
For more high level information see the wiki. If you are looking for the Vim plugin see VimDevIcons ➶.
Option 7: Patch Your Own 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
Patching the font of your own choosing for use with the VimDevIcons:
- requires: python2, 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] [-q] [-w] [-c] [--fontawesome]
[--fontawesomeextension] [--fontlinux] [--octicons]
[--powersymbols] [--pomicons] [--powerline]
[--powerlineextra] [--careful] [-ext [EXTENSION]]
[-out [OUTPUTDIR]]
font
Patches a given font with programming and web development related glyphs
(mainly for https://github.com/ryanoasis/vim-devicons)
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, --use-single-width-glyphs
Whether to generate the glyphs as single-width not
double-width (default is double-width)
-q, --quiet, --shutup
Do not generate verbose output
-w, --windows, --limit-font-name-length
Limit the internal font name to 31 characters (for
Windows compatibility)
-c, --complete Add all available Glyphs
--fontawesome Add Font Awesome Glyphs (http://fortawesome.github.io
/Font-Awesome)
--fontawesomeextension
Add Font Awesome Extension Glyphs
(http://andrelgava.github.io/font-awesome-extension)
--fontlinux Add Font Linux Glyphs (https://github.com/Lukas-W
/font-linux)
--octicons Add Octicons Glyphs (https://octicons.github.com)
--powersymbols Add IEC Power Symbols (http://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)
--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
| Unstable file paths warning |
| Reference the release branch and not the master branch because paths are subject 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 |
| Not: 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 I cannot provide or share due to the license:
- Input Mono (license restriction)
- Possibly coming with external hosting :)
- PragmataPro (not free)
- Consolas (proprietary)
Project History
Motivation (Original Rationale)
-
Originally created for use with vim-devicons vim plugin to add glyphs (icons) as labels for files based on the filetype extension or entire path. This project began as a part of the vim-devicons repo but soon it became apparent it did not belong tied to the vim plugin. I thought it may benefit others more as a separate project and allow a wider range of uses. This project started before I knew about Fontconfig provided solution, although a patched font still has some benefits over the Fontconfig.
-
project and repository previously known as 'nerd-filetype-glyphs-fonts-patcher' and 'font-nerd-icons'
Changelog
See changelog.md
License
MIT © Ryan L McIntyre