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] This is supposed to be \dot{x}_M and \ddot{x}_M.…

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.

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 …

[image] ufechner7: What is the suggested way to use Unicode in a README.md file? 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.)

[image] stevengj: so you probably need a better font I already installed extra fonts which did not help: [image]

[image] stevengj: (But for equations I would just use LaTeX now that GitHub supports it.) @baggepinnen Any comment?

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

Using Unicode in README.md file?

General Usage

Topic		Replies	Views
Looking beyond Unicode Internals & Design	8	1832	November 26, 2016
LaTeX in README.md file of a repo Tooling	2	1085	January 9, 2021
What do you use to embed Julia code in LaTeX? General Usage	56	22071	December 18, 2022
Typesetting Julia Code in Latex Documents (Unicode) Community	13	10407	September 29, 2025
Unicode characters in Julia Markdown not exported to pdf New to Julia markdown , weave , julia-markdown	8	728	February 22, 2024

Using Unicode in README.md file?

Related topics