Using Unicode in README.md file?

General Usage
1

If I look at the README at this website: GitHub - baggepinnen/TrajectoryLimiters.jl: Nonlinear filters to create dynamically feasible reference trajectories with Firefox the unicode characters are very distorted and hardly readable. Example:

image
image512×194 15.1 KB

This is supposed to be \dot{x}_M and \ddot{x}_M. This problem is much smaller when using Chrome, but still exists:

image
image512×194 12.4 KB

In Chrome, only the dots are shifted a bit to the right, but you can at least understand what is meant.

What is the suggested way to use Unicode in a README.md file?

Of course it is possible to use LaTeX $\dot{x}_M$ and $\ddot{x}_M$, but that does not render on JuliaHub and it is also not an option in the source code examples.

1 Like
2

I would use LaTeX, renders nice on GitHub and even when you include it in your docs. Sure JuliaHub does not have MathJax/KaTeX running, but isn‘t their their problem and not yours?

Do you have a use case for code examples? If that’s quarto (or Literate) in the docs or Pluto they would render LaTeX as well in their Markdown.
In comments in code I would maybe do less math, sure; In doc strings I heavily use math, though on REPL that sometimes doe not look that nice.

1 Like
3

The rendering is determined by your browser and font, so you probably need a better font if you want better rendering.

(But for equations I would just use LaTeX now that GitHub supports it.)

3 Likes
4

I already installed extra fonts which did not help:

image
image585×505 26.7 KB

5

@baggepinnen Any comment?

6

I have already given you my comment in the issue and PR you opened.

7

So for now my conclusion is, do NOT use Unicode characters in Julia code or in README.md without checking their readability on Github in the browser. I think most Greek letters are no problem. but variables like \dot{X} should be avoided.

1 Like
8

2 posts were split to a new topic: Complications of diacritical marks in Unicode