GlyphtConfig
type GlyphtConfig = {
input: string | string[];
outDir: string;
outCssFile?: string;
includeTtfInCss?: boolean;
basePath?: string;
settings: Record<string, FamilySubsetSettings>;
formats?: { ttf?: boolean; woff?: boolean; woff2?: boolean };
woffCompression?: number;
woff2Compression?: number;
}
Properties
input
input: string | string[]
One or more paths to input font files. These can be glob patterns.
outDir
outDir: string
The directory where the optimized fonts and CSS will be written.
This is resolved relative to the location of the config file.
OptionaloutCssFile
outCssFile?: string
The path to write the CSS file to. If not specified, it will be written to fonts.css in outDir.
OptionalincludeTtfInCss
includeTtfInCss?: boolean
If you choose to output .ttf files, whether or not to include them in the output CSS as a src. Defaults to
true if omitted.
OptionalbasePath
basePath?: string
A path to prepend to the font URLs in the generated CSS file.
settings
Subset settings for each font family.
Optionalformats
formats?: { ttf?: boolean; woff?: boolean; woff2?: boolean }
Which font formats to output. Defaults to {woff2: true}.
OptionalwoffCompression
woffCompression?: number
The Zopfli iteration count for WOFF compression (default: 15).
Optionalwoff2Compression
woff2Compression?: number
The Brotli compression level for WOFF2 compression, from 0 to 11 (default: 11).
The configuration format for the Glypht CLI. This is what you'll export from your config file.