jupyter-book icon indicating copy to clipboard operation
jupyter-book copied to clipboard

Improve documentation on using amsmath

Open joelmiller opened this issue 1 year ago • 1 comments

In this page, there are instructions on using amsmath: https://jupyterbook.org/en/stable/content/math.html

However, using the recommendation causes the instructions on in-line math (on the same page) to break. Single dollar signs in in-line text are now just treated as dollar signs.

It can be fixed using this: https://stackoverflow.com/questions/76694676/html-generated-by-jupyter-book-does-not-recognise-inline-equations

However, I suspect the way this is solved means that when I followed the instructions on using amsmath I inadvertently turned off all default extensions. The comments in the copied code made me think I might have doing this, but it wasn't it wasn't clear. I also had no idea what extensions I might be turning off.

It would be nice if the documentation made it clearer that we are turning off those extensions, and specifically included the instructions needed to keep inline math text working. It would also be nice if there is somewhere a list of the default extensions and if the documentation on adding amsmath points us to that list.

As it stands, I don't know what else I might have broken by adding amsmath.

joelmiller avatar Oct 02 '24 01:10 joelmiller

it does not render inline math.

jmelo11 avatar Feb 19 '25 22:02 jmelo11