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

Switch docs to use LaTeX instead of images #384

Open
wants to merge 3 commits into
base: devel
Choose a base branch
from

Conversation

henrygerardmoore
Copy link

@henrygerardmoore henrygerardmoore commented Nov 1, 2024

Currently the docs don't render well if you're in dark mode on github. Github supports inline LaTeX with MathJax, so this PR switches the docs to use that. It also removes a dead link. Here's a screenshot showing the difference (previewing in VSCode) where the bottom equation is using MathJax and the top one is the current image. This change also makes modifying the equations or creating new ones easier.

image

In reviewing, please do make sure I didn't make any typos in the LaTeX translations, and also feel free to add or change line breaks to make the .md files more readable 😄

Comment on lines -50 to -51
![Goldilocks principle](http://home.netcom.com/~swansont_2/goldilocks.jpg)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link is dead, but if there is another image that works well as an example here, feel free to add or request me to add it.

@henrygerardmoore
Copy link
Author

henrygerardmoore commented Nov 1, 2024

This all looks nice in vscode, but it seems that github has some MathJax rendering bugs that mean it doesn't look as nice online. I'm not going to close this PR preemptively but I understand if you prefer the original images.

Looks like this is somehow just an issue with my browser 😁

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

Successfully merging this pull request may close these issues.

1 participant