Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update MathJax to v3.2.0 #1743

Merged
merged 1 commit into from
Jan 7, 2022
Merged

Conversation

jmert
Copy link
Contributor

@jmert jmert commented Jan 2, 2022

This PR bumps MathJax 3 to v3.2.0.

Specifically, I'm interested in the the fact that "Processing of raw Unicode characters in TeX input has been improved." (https://www.mathjax.org/MathJax-v3.2.0-available/#other). For the sake of nicely readable docs in the terminal, I'm motivated to include Unicode characters directly in the docstrings of functions:

"""
Calculates the bearing angle (``α``), defined as the angle between the meridian (at the
first coordinate) and the great circle connecting the first coordinate to the second. Angles
are measured eastward of north and will be in the range ``[-π,π]``. See also
[`bearing2`](@ref).
"""
function bearing end

so that you see the literal characters in the help (rather than requiring the user to read and interpret \alpha or \pi):
image

The problem is that with the MathJax 3 renderer prior to v3.2.0, the math is rendered in the HTML docs as upright text characters rather than italic math characters:
image

Upgrading to MathJax 3.2.0 fixes this issue (and brings it inline with the behavior of the MathJax 2 renderer):
image
(Notice change in the alpha and pi characters.)

@fredrikekre fredrikekre merged commit 7beb208 into JuliaDocs:master Jan 7, 2022
@jmert jmert deleted the mathjax_3.2.0 branch January 7, 2022 18:44
@mortenpi mortenpi added Type: Enhancement Format: HTML Related to the default HTML output labels Mar 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Type: Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants