Welcome to the Font Bakery Documentation!

Font Bakery is command-line tool for checking the quality of font projects.

For a quick overview, check out the list of checks currently offered.

The project is licensed under the Apache v2.0 license and the source is available at https://github.com/fonttools/fontbakery.

Product Overview

• 1. Introduction
• 2. How does the Font Bakery project improve font production?
• 3. What is the opportunity for designers and foundries to collaborate on font quality assurance?
• 4. Why contribute publicly? Common goals with shared costs
• 5. Conclusion: Font Bakery’s “Secret Master Plan”

User Documentation

• Installation Guides
  • GNU + Linux Installation Guide
  • macOS Installation Guide
  • Windows Installation Guide
• Font Bakery Command Line Usage
  • fontbakery check-universal
  • fontbakery check-adobefonts / check-fontbureau / check-fontwerk / check-notofonts
  • fontbakery check-googlefonts
  • fontbakery check-fontval
  • Configuration file
• Bash Completion

Developer Documentation

• Getting Started as a Contributor
  • Getting Started
  • Accept the Google Contributor License Agreement
  • Go!
• Writing Profiles
  • From automatic discovery to full control
  • Running profiles
  • Writing Profiles: Quick start
• Source Code Contributor Guide
  • Create a Font Bakery Development Environment
  • Custom Font Bakery Profiles
  • Source Code Testing
  • Propose Source Code Changes
  • Community Guidelines
  • License
• Documentation Contributor Guide
  • Create a Font Bakery Development Environment
  • Documentation Style Guide
  • Build Local Documentation
  • Review Local Documentation
  • Propose Documentation Changes
  • Community Guidelines
  • License

Maintainer Documentation

• Project Maintainer Notes
  • Code Testing
  • Updating the distribution package
  • Cached Vendor ID data

Source Documentation

• fontbakery
  • callable
  • checkrunner
  • cli
  • commands
  • constants
  • fonts_public_pb2
  • fonts_profile
  • glyphdata
  • message
  • reporters
  • profiles
  • utils

Indices

• Index

• Module Index