Skip to content

Commit

Permalink
Add a note to the math vignette section
Browse files Browse the repository at this point in the history
  • Loading branch information
@jayhesselberth
jayhesselberth committed Dec 20, 2024
1 parent d137af5 commit 8854300
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion vignettes/customise.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ template:

### Math rendering

By default, pkgdown will render math using mathml. mathml is the official standard for rendering math on the web, and requires no additional javascript or css dependencies. However, browser support for complex math is not always that good, so if you are including complex equations in your documentation, you may want to switch to either [`katex`](https://katex.org) or [`mathjax`](https://www.mathjax.org) by using the `template.math-rendering` field:
By default, pkgdown will render math using [mathml](https://w3c.github.io/mathml/). mathml is the official standard for rendering math on the web, and requires no additional javascript or css dependencies. However, browser support for complex math is not always that good, so if you are including complex equations in your documentation, you may want to switch to either [`katex`](https://katex.org), which we recommend for display of complex math expressions, or [`mathjax`](https://www.mathjax.org) by using the `template.math-rendering` field:

```yaml
template:
Expand Down

0 comments on commit 8854300

Please sign in to comment.