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

LaTeX in documentation #3610

Open
mahrud opened this issue Dec 14, 2024 · 1 comment
Open

LaTeX in documentation #3610

mahrud opened this issue Dec 14, 2024 · 1 comment

Comments

@mahrud
Copy link
Member

mahrud commented Dec 14, 2024

We should find ways to discourage using ad-hoc ways of putting math in the documentation and encourage using the $ ... $ and $$ ... $$ notation.

Here are some ideas:

  • We could have more strict requirements when reviewing pull requests, but we should make this easy on the reviewer. For instance, GitHub actions could automatically uploaded the generated documentation somewhere easy to view.
  • As a heuristic, we could have the documentation system temporarily give an error for symbols like ^ and _ or + and * in the text sections of every node and use those to identify a list of nodes that need fixing.

Tangentially, it would be great if M2-mode could replace strings wrapped in $ .. $ with rudimentary tex, but this may be nontrivial.

@d-torrance
Copy link
Member

Tangentially, it would be great if M2-mode could replace strings wrapped in $ .. $ with rudimentary tex, but this may be nontrivial.

It can! See https://github.com/Macaulay2/M2/wiki/Previewing-TeX-in-Macaulay2-Emacs-buffers

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

No branches or pull requests

2 participants