Web3 DAO | Ethereum Foundation Logo

Mathematical expression support for markdown


Ethereum Foundation






Is your feature request related to a problem? Please describe. Currently our markdown does not support syntax for mathematical expressions. Although these are not super frequent, having the ability to properly display mathematical expressions could expand our ability to convey certain concepts. I suspect we could use more math examples if we had the proper support for them.

Surfaced while working through the new page related to proof-of-stake rewards and penalties.

Describe the solution you'd like https://github.blog/2022-05-19-math-support-in-markdown/ GitHub recently rolled out a similar feature, which can be used with $ or $$ delimiters. ie. $e^{i \pi} = -1$ instead of e^(i*pi) = -1 Not sure exactly what library they use. Couple possible libraries https://www.gatsbyjs.com/plugins/gatsby-remark-katex/ https://www.mathjax.org/

Describe alternatives you've considered Just leave the markdown as is, and type all math examples with inline text. :-(

Additional context The method chosen should be sure to support dark mode color themes. Ideally text is still selectable, rather than rendered as an image. Ideally also support RTL languages, but not certain how that would play in.

Example of mathematic expressions being used: https://eth2book.info/altair/annotated-spec/#reward-and-penalty-calculations

Want to contribute? We love contributions from the Ethereum community! Please comment on an issue if you're interested in helping out with a PR.