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

Make a logo, possibly using QuantumToolbox.jl #83

Closed
albertomercurio opened this issue Apr 29, 2024 · 2 comments · Fixed by #105
Closed

Make a logo, possibly using QuantumToolbox.jl #83

albertomercurio opened this issue Apr 29, 2024 · 2 comments · Fixed by #105
Labels
documentation Improvements or additions to documentation

Comments

@albertomercurio
Copy link
Member

albertomercurio commented Apr 29, 2024

Make a logo for the package, possibly using the QuantumToolbox.jl package.

What I have in mind is for example creating the Wigner function a triangular cat state

$$ \ket{\psi} = \ket{\alpha} + \ket{e^{i \frac{2}{3} \pi} \alpha} + \ket{e^{i \frac{4}{3} \pi} \alpha} $$

and possibly mapping the colors following the Julia logo.

Then, we can add a documentation page demonstrating how this logo was made, showing step by step the code.

@albertomercurio albertomercurio added the documentation Improvements or additions to documentation label Apr 29, 2024
@ytdHuang
Copy link
Member

Good idea !

@ytdHuang
Copy link
Member

ytdHuang commented May 1, 2024

@albertomercurio

I suggest the background color of the logo to be transparent.

Then, we can prepare two different logo (for light- and dark-theme website), and put it in the folder docs/src/assets/.

The file name must be:

  • logo.png: logo for light-theme website, maybe with the black color characters (QuantumToolbox) in the logo
  • logo-dark.png: logo for dark-theme website, maybe with the white color characters (QuantumToolbox) in the logo: QuantumToolbox)

In this case, the Documenter.jl will automatically detect the logo files if it is located in docs/src/assets/.

Also, we can insert the logo to README.md by adding the following lines in the beginning:

![Fancy logo](./docs/src/assets/logo-dark.png#gh-dark-mode-only)
![Fancy logo](./docs/src/assets/logo.png#gh-light-mode-only)

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

Successfully merging a pull request may close this issue.

2 participants