breandan / kotlingrad

šŸ§© Shape-Safe Symbolic Differentiation with Algebraic Data Types
https://breandan.net/public/masters_thesis.pdf#page=49
Apache License 2.0
520 stars 21 forks source link

Formulas and diagrams in README not visible in dark mode #32

Open aSemy opened 1 year ago

aSemy commented 1 year ago

Hi šŸ‘‹

I've got GitHub dark mode enabled.

When I look at the README, I'm not able to view the diagrams and formulas.

When I look at the dataflow graphs directly, because they are SVGs GitHub renders them with a transparent background

image

Suggestions

SVG Images

Here are my suggestions for improving the visibility of the SVG images:

Formulas

For the formulas I see that they are images that are referenced using the GitHub API

https://github.com/breandan/kotlingrad/blob/0.4.5/README.md?plain=1#L113

https://github.com/breandan/kotlingrad/blob/0.4.5/README.md?plain=1#L134

Perhaps the GitHub syntax might support dark mode? https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions

Here are some examples:

Inline expression (using dollars): $\mathbf{A}(\mathbf{B})$

Block using $$:

$$\mathbf{A}(\mathbf{B})$$

Block using code fence math code fence block:

\mathbf{A}(\mathbf{B})

They look good to me! Screenshot of the above example

image