Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
@michaeltaranto
michaeltaranto committed Jan 29, 2023
1 parent cd681ac commit f74ddec
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion packages/metrics/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The font metrics object returned contains the following properties if available:
| lineGap | number | The amount of space included between lines |
| unitsPerEm | number | The size of the font’s internal coordinate grid |
| xHeight | number | The height of the main body of lower case letters above baseline |
| xWidthAvg | number | The average width of lowercase characters.<br/><br/>currently derived from latin [character frequencies] in English language, falling back to the built in [xAvgCharWidth] from the OS/2 table. |
| xWidthAvg | number | The average width of lowercase characters.<br/><br/>Currently derived from latin [character frequencies] in English language, falling back to the built in [xAvgCharWidth] from the OS/2 table. |

[character frequencies]: https://en.wikipedia.org/wiki/Letter_frequency#Relative_frequencies_of_letters_in_other_languages
[xavgcharwidth]: https://learn.microsoft.com/en-us/typography/opentype/spec/os2#xavgcharwidth
Expand Down
20 changes: 10 additions & 10 deletions packages/unpack/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,16 @@ const metrics = await fromFile(filePath);

The font metrics object returned contains the following properties:

| Property | Type | Description |
| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------ |
| familyName | string | The font family name as authored by font creator |
| capHeight | number | The height of capital letters above the baseline |
| ascent | number | The height of the ascenders above baseline |
| descent | number | The descent of the descenders below baseline |
| lineGap | number | The amount of space included between lines |
| unitsPerEm | number | The size of the font’s internal coordinate grid |
| xHeight | number | The height of the main body of lower case letters above baseline |
| xWidthAvg | number | The average width of lowercase characters (currently derived from latin character frequencies in English language) |
| Property | Type | Description |
| ---------- | ------ | ----------------------------------------------------------------------------------------------------------------- |
| familyName | string | The font family name as authored by font creator |
| capHeight | number | The height of capital letters above the baseline |
| ascent | number | The height of the ascenders above baseline |
| descent | number | The descent of the descenders below baseline |
| lineGap | number | The amount of space included between lines |
| unitsPerEm | number | The size of the font’s internal coordinate grid |
| xHeight | number | The height of the main body of lower case letters above baseline |
| xWidthAvg | number | The average width of lowercase characters. Currently derived from latin character frequencies in English language |

## Thanks

Expand Down

0 comments on commit f74ddec

Please sign in to comment.