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

Extend Python docs with dark mode #1442

Closed
bossenti opened this issue Mar 22, 2023 · 14 comments · Fixed by #1454
Closed

Extend Python docs with dark mode #1442

bossenti opened this issue Mar 22, 2023 · 14 comments · Fixed by #1454
Assignees
Labels
documentation Everything related to documentation good first issue Good for newcomers
Milestone

Comments

@bossenti
Copy link
Contributor

Body

Our Python docs are built using mkdocs-material.
This allows to easily configure a dark mode as described here: https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/?h=dark+mode#color-palette-toggle
This issue is about configuring the dark mode for our Python docs via the mkdocs.yml. Please pay some attention on the selected primary and accent color for the dark theme.

Monitoring

As this issue is marked as good first issue: one of @SvenO3 , or @bossenti are happy to provide help for getting started, just tag (one of) them if you want to start working on this issue and need some help.
This issue is ideal for people that are interested in getting started with StreamPipes, and want to get a little hands-on to our Python library.

StreamPipes Committer

I acknowledge that I am a maintainer/committer of the Apache StreamPipes project.

@bossenti bossenti added this to the 1.0.0 milestone Mar 22, 2023
@bossenti bossenti added good first issue Good for newcomers documentation Everything related to documentation labels Mar 22, 2023
@dev-DTECH
Copy link
Contributor

Hey, I want to work on this issue.

@dev-DTECH
Copy link
Contributor

Thank you @tenthe for assigning this issue to me.

@dev-DTECH
Copy link
Contributor

What about the logo?

its getting a bit unreadable due to dark colors

image

@tenthe
Copy link
Contributor

tenthe commented Mar 24, 2023

Yes, you are right it is quite unreadable. @bossenti is it possible to use the white logo for dark mode?

@bossenti
Copy link
Contributor Author

For images within markdown files there is a functionality to distinguish between dark and light mode:https://squidfunk.github.io/mkdocs-material/reference/images/#light-and-dark-mode
However, I think this does not apply for the general logo (appearing in the top left corner)

@dev-DTECH
Copy link
Contributor

So I edited the logo to improve the readability with dark mode.

Is it ok to use this logo?

Light Mode -

image

Dark Mode -

image

@dev-DTECH
Copy link
Contributor

@bossenti is it legal to use this edited logo? like no license issue etc...

@tenthe
Copy link
Contributor

tenthe commented Mar 27, 2023

Hello @dev-DTECH,
thanks for the PR.
I would prefer to use the all white logo instead, like the one in the upper left corner.

@dev-DTECH
Copy link
Contributor

Ok sure

@dev-DTECH
Copy link
Contributor

@tenthe What about the python logo its not there in the all white logo.

Should I add it?
image

@tenthe
Copy link
Contributor

tenthe commented Mar 27, 2023

I think it would be good if it looks the same for light and dark mode.
It should be enough if you take the green out of the current logo (streampipes-python-dark.png)

@dev-DTECH
Copy link
Contributor

ok got it @tenthe

@dev-DTECH
Copy link
Contributor

@tenthe I have committed with the white logo, please accept the PR.

It looks like this now
image

@bossenti bossenti linked a pull request Apr 2, 2023 that will close this issue
@bossenti
Copy link
Contributor Author

bossenti commented Apr 2, 2023

completed with #1454

@bossenti bossenti closed this as completed Apr 2, 2023
@bossenti bossenti modified the milestones: 1.0.0, 0.92.0 May 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Everything related to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants