quarto-dev / quarto-dev/quarto-cli

enhancement: add MathJax equation numbering for math environments in html

Open
#4,136 12 comments 2 reactions 1 assignee View on GitHub

@cscheid is already working on this.

Since Jan 28, 2023.

crossref enhancement math
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

By default, MathJax does not have equation numbers when the LaTeX math environments are used. This:

---
title: "test6"
format: html
---

\begin{equation}\label{eq-a}
a
\end{equation}

produces this:
image
instead of this (with numbers)
image

The reason is that the default behavior for MathJax is to not show the equation numbers. This causes endless confusion for those who use the math environment, which is used for more complex math.

It'd be great if Quarto turned on equation numbering in math environments by default so that html and PDF output behaves the same. All that is needed is to have this script in the header if the equation engine is mathjax:

<script>
MathJax = { 
    tex: { 
        tags: 'ams'  // should be 'ams', 'none', or 'all' }
     };
</script>

Obviously you can turn this on manually with

---
title: "test5"
  html:
    include-in-header: mathjax.html
---

with mathjax.html having the script above but most users spend hours and hours trying to debug lack of numbers until they stumble upon the right solution. What is worse, is that the solution depends on the MathJax version. The above is the method for the version being used by Quarto (by default).

I don't think there is any reason to have the numbering turned off. Anyone using the LaTeX math environment is likely to be a LaTeX user and we have a standard methods for selectively turning off numbers on an equation if that were wanted.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.