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

Render mathematical expressions in docs #6

Open
sbrunk opened this issue Jan 22, 2023 · 1 comment
Open

Render mathematical expressions in docs #6

sbrunk opened this issue Jan 22, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@sbrunk
Copy link
Owner

sbrunk commented Jan 22, 2023

We want to be able to render math expression in our docs (Scaladoc as well as Laika docs), like PyTorch does with MathJax:

image

For Scaladoc there is an open issue already scala/scala3#15433 but I haven't gotten around to work on it yet. For Laika it should be easier as we control the template so we could try to embed MathJax or Katex there.

@sbrunk sbrunk added the documentation Improvements or additions to documentation label Jan 22, 2023
@sbrunk
Copy link
Owner Author

sbrunk commented Feb 6, 2023

Done for Laika (introductory docs) in #12 with KaTeX, but still needs to be done for Scaladoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant