Skip to content

Easily build "Hack" font with or without custom modifications in a Docker container

License

Notifications You must be signed in to change notification settings

CodingMarkus/DockerHackFont

 
 

Repository files navigation

Docker Hack Font

This is a fork of the Hack font master repository. The reason why this fork exists is to add Docker support, so you can easily build your own Hack font release (possibly with modifications) on any system with Docker (or compatible engine) installed.

Sample usage:

  1. Build a Docker image:
docker image build --tag hack_image .
  1. Use it to build a Hack variant with slashed zero:
docker run --name hack hack_image sh -c "
    ./create-alt-hack.sh /tmp/hack u0030-forwardslash
    && cd /tmp/hack
    && make
    && ALT_HACK_VERSION=slashed_zero
      HACK_ARCHIVES_DIR=/tmp/hack_arch
      make archives
  "

docker cp hack:/tmp/hack_arch/. ~/Documents/Hack_with_slashed_zero

docker container rm hack
  1. You can build as many different variants as you like by repeating step (2) and specifying other modifications. Changes to the Docker image during step (2) are not persistent.

  2. Delete the image again:

docker image rm hack_image

Modifications in this Fork

  • Added a Dockerfile containing the image bulid instructions.

  • Had to patch Alpine Linux's stdbool.h to make ttfautohint build (was easier than patching ttfautohint to be correct), so I added a patch file for that.

  • Made all natives builds detect the number of CPU cores available and use parallel building, which significantly speeds up some of the Docker image build steps.

  • Modified the build scripts to support a new option --install-dependencies-only which installs all required dependencies for building without actually building anything. This was required for the Docker image setup.

  • Wrote a script create-alt-hack.sh that creates a copy of the Hack source folder and then applies desired modifications from the alt-hack repository to it. It will not only correctly replace the glyphs but also remove any manual hints from the ttfautohint config files for glyphs it has replaced.

  • Fixed a problem with the ttfautohint-build.sh script that tried to apply patches but actually failed. Migrated to the latest version of that script and modified it in such a way that it requires as little temporary space when building as possible to not blow up any container or virtual file systems; also after each successful build, all source and build data is removed again. The script is now also fail-safe and stops if any called command failed.

  • Fixed a problem with the archiver.sh script that was using wrong relative paths when called from the Makefile (which seems intended if there is a dedicated make target for that). Also all the config variables of the script can be now be overridden by environment variables of the same name and a variant version may be given. The script is now also fail-safe and stops if any called command failed.

  • Fixed ttfautohint hinting files. The characters in the manual hinting files must be addressed by names in current ttfautohint builds, not by Unicode numbers as used to be the case in the past; this change has already been performed on the dev branch but was missing on the master branch, so I cherry-picked it from there.



Original README.md follows below.


Hack

GitHub release Build Status Contributors Join the chat at https://gitter.im/source-foundry/Hack Github All Releases

Don't like the development noise from the repository but want to keep up with changes? Check out our gitter Hack channel. Have a quick question that doesn't require an issue report? Drop by our gitter Help channel and ask away.

A typeface designed for source code

Hack is designed to be a workhorse typeface for source code. It has deep roots in the free, open source typeface community and expands upon the contributions of the Bitstream Vera & DejaVu projects. The large x-height + wide aperture + low contrast design make it legible at commonly used source code text sizes with a sweet spot that runs in the 8 - 14 range. The full set of changes to the upstream source are available in the changelog.

The project is in active development, and we welcome your input and contributions. You may view our design objectives and instructions on how to contribute in CONTRIBUTING.md.

Frequently asked questions are answered in our FAQ.

Contents

Specimen

Hack — a typeface designed for source code

Overview of features

  • Typeface Name: Hack
  • Category: Monospaced
  • Character set support: ASCII, Latin-1, Latin Extended A, Greek, Cyrillic
  • Powerline Support: Yes, included by default
  • Included Styles: Regular, Bold, Italic, Bold Italic

Quick installation

NOTE ON FONT UPDATES If you are updating your version of Hack, be sure to remove the previously installed version and clear your font cache first to avoid conflicts that can lead to platform-specific rendering errors. Many platforms/distros offer package managers that automate this process. We release a Windows installer to automate the install/update process on the Windows platform. See below for additional details.

Linux

  1. Download the latest version of Hack.
  2. Extract the files from the archive (.zip).
  3. Copy the font files to either your system font folder (often /usr/share/fonts/) or user font folder (often ~/.local/share/fonts/ or /usr/local/share/fonts).
  4. Copy the font configuration file in config/fontconfig/ to either the system font configuration folder (often /etc/fonts/conf.d/) or the font user folder (often ~/.config/fontconfig/conf.d)
  5. Clear and regenerate your font cache and indexes with the following command:
$ fc-cache -f -v

You can confirm that the fonts are installed with the following command:

$ fc-list | grep "Hack"

Some Linux users may find that font rendering is improved on their distro with these instructions.

macOS

  1. Download the latest version of Hack.
  2. Extract the files from the archive (.zip) and click to open them.
  3. Follow the instructions from your operating system.
  4. Enjoy!

Windows

Hack Windows Installer

The Hack Windows Installer simplifies installation on the Windows platform. The tool guides you through the installation process and addresses some common rendering issues that occur with font installs/updates on the Windows platform. This tool is the recommended installation approach for Windows users.

Chrome/ChromeOS

To use with Secure Shell, edit the following fields in Options:

  • font-family: "Hack"
  • user-css: https://cdn.jsdelivr.net/npm/hack-font@3/build/web/hack.css

Package managers

We highly recommend the convenience of a community developed package manager or other auto-updating utility if this is available on your platform. While the package manager releases may be a bit delayed relative to the repository releases, the packages distributed through these package managers were designed to tune and automate font installs and updates on your system.

We are aware of Hack support in the following package managers (with associated package names):

  • Arch Linux: ttf-hack
  • Chocolatey (Windows): hackfont
  • Debian: fonts-hack-ttf
  • Fedora / CentOS: dnf-plugins-core :: heliocastro/hack-fonts :: hack-fonts
  • Gentoo Linux: media-fonts/hack
  • Homebrew Cask (OS X): homebrew/cask-fonts/font-hack
  • Open BSD: fonts/hack-fonts
  • OpenSUSE: hack-fonts
  • Ubuntu: fonts-hack-ttf
  • Visual Studio Package Manager: hack.font

For installation issues with Hack packages, please contact the package maintainer directly.

Web font usage

Hack is available in the woff and woff2 web font formats. Bold and italic styles are included by default and work out-of-the-box via the <strong> and <em> tags.

Hack is available through the jsDelivr and cdnjs CDN services:

jsDelivr cdnjs

The following snippets provide examples of Hack web font use through the jsDelivr CDN. Adjust the URL paths to those provided by cdnjs (click the link above to find the appropriate URL) to switch to the cdnjs CDN.

1. Add Hack to HTML

Include one of the following in the <head> section of your HTML file:

Subset web fonts

<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3/build/web/hack-subset.css">

Full character set web fonts

<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3/build/web/hack.css">

2. Add Hack to CSS

pre, code { font-family: Hack, monospace; }

See the WEBFONT_USAGE.md documentation for additional details, including instructions on how to download, host, and serve the web fonts on your web server.

Additional tools for Hack font customization

Customize your build with alternate glyph styles

The alt-hack library includes a (growing) collection of alternate glyph styles that can be used to customize your Hack fonts. Don't like the default zero style? Swap out the UFO design source with a slashed zero or dotted zero and build new fonts that work better for you.

We welcome contributions of new alternate glyph styles in the alt-hack repository. Design something new that works well with rest of the typeface and submit a pull request to the alt-hack repository so that others can use it in their custom builds.

Detailed build instructions are available on the alt-hack repository README.md. Font renaming instructions to support side-by-side installs with upstream Hack are available below.

Line spacing adjustments

font-line is a tool that modifies the default line spacing used in the Hack design (20% UPM).

The following gist installs font-line and modifies line spacing for all desktop font files contained in the same directory:

Install modified and unmodified versions of Hack on the same system

If you modify the upstream Hack source or the released font binaries and would like to install your modified fonts on the same system with the Hack fonts as released here, you can use the fontname.py Python script to define a new font name in the binary files. For example, you can install Hack on your platform along with a 15% UPM line spacing adjusted version as Hack Fifteen. Modify default glyphs with those in our alt-hack repository or design your own and define your creation with any name that you'd like. Following installation, your renamed fonts should show under the name that you define with the script so that you can switch between any of them as you need.

Usage details and examples are provided on the fontname.py repository README.

Resources

Contributing

We welcome contributions to Hack! Please review our CONTRIBUTING.md document for details.

Built With

Hack is built with the following free, open source projects:

  • Font Bakery - post-compilation modifications
  • fontmake - UFO to ttf compilation
  • fontTools - OpenType table read/write
  • font-v - font version string editor
  • ink - stream editor for text file templating
  • OpenFV - open specification for semantic typeface versioning
  • sfnt2woff_zopfli - ttf to woff web font compilation
  • ttfautohint - ttf instruction sets
  • uni - Unicode code point search
  • ufodiff - UFO source diffs
  • ufoLib - UFO source file reads/writes/testing
  • ufolint - UFO source file linting for CI testing
  • woff2 - ttf to woff2 web font compilation

Acknowledgments

We would like to acknowledge and thank the jsDelivr and cdnjs teams for their support of the Hack project through their free web font CDN services. We greatly appreciate the tremendous support of open source software development by the Semaphore CI team. Their free CI testing service and rapid, excellent technical support have been tremendous assets for our project. Lastly, a huge thanks go out to all of those who do the unrecognized work to get Hack out there to users so that it is easy to access, install, upgrade, and use. There are redistribution package managers, review committee members, testers, and others across platforms/distros/applications who perform this thankless work and often go unrecognized. Your efforts are much appreciated.

License

Hack work is © 2018 Source Foundry Authors. MIT License

Bitstream Vera Sans Mono © 2003 Bitstream, Inc. (with Reserved Font Names Bitstream and Vera). Bitstream Vera License.

The font binaries are released under a license that permits unlimited print, desktop, web, and software embedding use for commercial and non-commercial applications.

See LICENSE.md for the full texts of the licenses.

About

Easily build "Hack" font with or without custom modifications in a Docker container

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 75.4%
  • Python 16.6%
  • CSS 3.8%
  • Dockerfile 3.0%
  • Makefile 1.2%