apache / streampipes

Apache StreamPipes - A self-service (Industrial) IoT toolbox to enable non-technical users to connect, analyze and explore IoT data streams.
https://streampipes.apache.org
Apache License 2.0
560 stars 172 forks source link

Extend Python docs with dark mode #1442

Closed bossenti closed 1 year ago

bossenti commented 1 year ago

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.

dev-DTECH commented 1 year ago

Hey, I want to work on this issue.

dev-DTECH commented 1 year ago

Thank you @tenthe for assigning this issue to me.

dev-DTECH commented 1 year ago

What about the logo?

its getting a bit unreadable due to dark colors

image

tenthe commented 1 year ago

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

bossenti commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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

tenthe commented 1 year ago

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 commented 1 year ago

Ok sure

dev-DTECH commented 1 year ago

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

Should I add it? image

tenthe commented 1 year ago

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 commented 1 year ago

ok got it @tenthe

dev-DTECH commented 1 year ago

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

It looks like this now image

bossenti commented 1 year ago

completed with #1454