Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 10:30:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: add section about font discovery

Browse Source
This commit is contained in:
Lovell Fuller 2022-07-23 16:31:00 +01:00
parent 974fab946e
commit 3e327a586c
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/install.md
View File

@ -288,6 +288,27 @@ buildSync({
esbuild app.js --bundle --platform=node --external:sharp esbuild app.js --bundle --platform=node --external:sharp
``` ```
## Fonts
When creating text images or rendering SVG images that contain text elements,
`fontconfig` is used to find the relevant fonts.
On Windows and macOS systems, all system fonts are available for use.
On Linux systems, fonts that include the relevant
[`fontconfig` configuration](https://www.freedesktop.org/software/fontconfig/fontconfig-user.html)
when installed via package manager are available for use.
If `fontconfig` configuration is not found, the following error will occur:
```
Fontconfig error: Cannot load default config file
```
In serverless environments where there is no control over font packages,
use the `FONTCONFIG_PATH` environment variable to point to a custom location.
Embedded SVG fonts are unsupported.
## Worker threads ## Worker threads
On some platforms, including glibc-based Linux, On some platforms, including glibc-based Linux,

2
docs/search-index.json
View File

File diff suppressed because one or more lines are too long