nerd-fonts


Ⅰ. 插件描述

Iconic font aggregator, collection, & patcher. 3,600+ icons, 50+ patched fonts: Hack, Source Code Pro, more. Glyph collections: Font Awesome, Material Design Icons, Octicons, & more

Ⅱ. 基本信息

创建日期:  2014-12-05
使用用户:  21
Github星:  19873
插件作者:  Ryan L McIntyre

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:
Plugin 'ryanoasis/nerd-filetype-glyphs-fonts-patcher'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall

对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:
NeoBundle 'ryanoasis/nerd-filetype-glyphs-fonts-patcher'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:
Plug 'ryanoasis/nerd-filetype-glyphs-fonts-patcher'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:
cd ~/.vim/bundle
git clone https://github.com/ryanoasis/nerd-fonts

Ⅳ. 文档说明

<h1 align="center">
Nerd Fonts Logo
</h1>
<h2 align="center">
Iconic font aggregator, collection, and patcher
</h2>

<div align="center">

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

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

</div>

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:

<p align="center">
@SankeyMATIC Diagram
</p>
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

:mag: :mag: You can now search for glyphs easily on NerdFonts.com via the [Cheat Sheet][]

See Wiki: Glyph Sets and Codepoints for more details

Icon names in shell

See Wiki: Icon names in shell

Patched Fonts

Font NameFont Name and Repository*RFNEM SizeStatus
3270 Nerd Font3270NO1000![w] ![m2] ![l]
AgaveAgaveNO2048![w] ![m2] ![l]
Anonymice Nerd FontAnonymous ProNO2048![w] ![m2] ![l]
ArimoArimoNO2048![w] ![m2] ![l]
Aurulent Sans Mono Nerd Font NO1000![w] ![m2] ![l]
BigBlueTerminal NO1200![w] ![m2] ![l]
Bitstream Vera Sans Mono Nerd Font NO2048![w] ![m2] ![l]
Blex*IBM Plex MonoYES1000![w] ![m2] ![l]
Caskaydia Cove Nerd Font*Cascadia CodeYES2048![w] ![m2] ![l]
Code New Roman Nerd Font NO2048![w] ![m2] ![l]
Cousine Nerd FontCousineNO1000![w] ![m2] ![l]
DaddyTimeMonoDaddyTimeMonoNO1024![w] ![m2] ![l]
DejaVu Sans Mono Nerd Font NO2048![w] ![m2] ![l]
Droid Sans Mono Nerd Font NO2048![w] ![m2] ![l]
Fantasque Sans Nerd FontFantasque SansNO2048![w] ![m2] ![l]
Fira Code Nerd FontFira CodeNO1000![w] ![m2] ![l]
Fira Mono Nerd FontFiraNO1000![w] ![m2] ![l]
Go Mono Nerd FontGo-MonoNO1000![w] ![m2] ![l]
Gohu Nerd FontGohu TTF,GohuNO1000![w] ![m2] ![l]
Hack Nerd FontHackNO2048![w] ![m2] ![l]
Hasklug Nerd Font*HaskligYES1000![w] ![m2] ![l]
Heavy Data Mono Nerd Font NO2048![w] ![m2] ![l]
Hermut Nerd Font NO1000![w] ![m2] ![l]
iM-Writing*iA-WriterYES1000![w] ![m2] ![l]
Inconsolata Nerd Font NO1000![w] ![m2] ![l]
Inconsolata Go Nerd Font NO1000![w] ![m2] ![l]
Inconsolata LGC Nerd Font NO1000![w] ![m2] ![l]
Iosevka Nerd FontIosevkaNO1000#83
JetBrains MonoJetBrains MonoNO1000![w] ![m2] ![l]
Lekton Nerd Font NO1000![w] ![m2] ![l]
Literation Mono Nerd Font*LiberationYES2048![w] ![m2] ![l]
Meslo Nerd Font NO2048![w] ![m2] ![l]
Monofur Nerd Font NO2400![w] ![m2] ![l]
Monoid Nerd Font NO1536![w] ![m2] ![l]
Mononoki Nerd FontMononokiNO1024![w] ![m2] ![l]
M+ (MPlus) Nerd Font NO1000![w] ![m2] ![l]
Noto NO1000![w] ![m2] ![l]
OpenDyslexic NO1000![w] ![m2] ![l]
Overpass NO1000![w] ![m2] ![l]
ProFont (Windows tweaked) Nerd Font NO1200![w] ![m2] ![l]
ProFont (x11) Nerd Font NO1000![w] ![m2] ![l]
ProggyClean Nerd Font NO2048Imperfect
Roboto Mono NO2048![w] ![m2] ![l]
Sauce Code Nerd FontSourceYES1000![w] ![m2] ![l]
Shure Tech Mono Nerd Font*Share Tech MonoYES1000![w] ![m2] ![l]
Space Mono Nerd FontSpace MonoNO1000![w] ![m2] ![l]
Terminess Nerd Font*Terminus FontYES1000![w] ![m2] ![l]
Tinos NO2048![w] ![m2] ![l]
Ubuntu Nerd Font NO1000![w] ![m2] ![l]
Ubuntu Mono Nerd Font NO1000![w] ![m2] ![l]
Victor MonoVictor MonoNO1000![w] ![m2] ![l]

*RFN = Reserved Font Name

Combinations

  • Over 1,428,000 unique variations/combinations (Power Set) of patched fonts:

    • 50 patched font typefaces
    • 697 patched font families
    • 2,788 'complete' variations/combinations
    • 1,428,110 possible variations/combinations
    • 1,430,898 total calculated combinations (2,788 + 1,428,110)
  • 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 Cask Fonts on macOS (OS X)

brew tap homebrew/cask-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 (mostly due to Repository size) 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

<h2 align="center" id="font-patcher">

<img src="images/nerd-fonts-patcher-logo.png" alt="Nerd Fonts Patcher">

</h2>

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 specified 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: 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:

    • :white_check_mark: Use: https://github.com/ryanoasis/nerd-fonts/blob/0.9.0/patched-fonts/Hermit/Medium/complete/Hurmit%20Medium%20Nerd%20Font%20Complete.otf
    • :x: 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

Project Motivation

See Wiki: Project Purpose

Changelog

See changelog.md

License

MIT © Ryan L McIntyre

<!--
Repo References
-->

<!--
Website References
-->

<!--
Link References
-->

<!--
Font repos
-->

<!--
Patched Font internal links
-->

<!--
Quick Link Images
-->

<!--
Patched Font Statuses
-->

添加新评论