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

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

Open
aSemy opened this issue Dec 22, 2022 · 0 comments
Open

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

aSemy opened this issue Dec 22, 2022 · 0 comments

Comments

@aSemy
Copy link

aSemy commented Dec 22, 2022

Hi 👋

I've got GitHub dark mode enabled.

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

  • The formulas in the 'Math' column are black text on a transparent background
    image
  • I can see the blue/red arrows in the dataflow graph, but the text is also black
    image

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant