Skip to content

Commit

Permalink
add font render issue to faq
Browse files Browse the repository at this point in the history
  • Loading branch information
FredHappyface committed Aug 26, 2024
1 parent edea4dc commit 1184f52
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,9 @@ where to look for certain things:
- The [Technical Reference](/documentation/reference) documents APIs and other aspects of the
machinery. This documentation describes how to use the classes and functions at a lower level
and assume that you have a good high-level understanding of the software.
<!--
- The [Help](/documentation/help) guide provides a starting point and outlines common issues that you
may have.
-->


## Install With PIP

Expand Down
21 changes: 21 additions & 0 deletions documentation/help/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@

# FAQs

**Q: Why does the font look off when using AnsiToImg, especially on Android or other platforms?**

AnsiToImg cannot meaningfully control the font used when rendering text, as it relies on the OS
and the Playwright library (which uses the Chromium browser to render SVGs). This means that font
rendering issues, such as alignment problems or incorrect fonts, are often caused by the system's
font fallback mechanisms.

Android users may particularly notice this issue due to how Android handles font fallbacks.
Unfortunately, this is not something AnsiToImg can directly control. The issue stems from upstream,
meaning it would need to be resolved by the Android platform itself.

For more in-depth information about font fallback issues, I recommend reading articles by **Tonsky**,
the creator of Fira Code. They explain these kinds of problems much better than I could. You can
check out one of their posts here: [Font Size Article by Tonsky](https://tonsky.me/blog/font-size/).

Here's another example of a similar alignment issue in a different project:
[Nushell Issue #83](https://github.com/nushell/nushell.github.io/issues/83). In that case, the
developers also faced limitations due to upstream dependencies.

0 comments on commit 1184f52

Please sign in to comment.