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

docs: add new logo as favicon #5501

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add new logo as favicon #5501

wants to merge 1 commit into from

Conversation

martinvonz
Copy link
Member

Checklist

If applicable:

  • I have updated CHANGELOG.md
  • I have updated the documentation (README.md, docs/, demos/)
  • I have updated the config schema (cli/src/config-schema.json)
  • I have added tests to cover my changes

Copy link
Contributor

@ilyagr ilyagr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can test this out. It will only affect the prerelease site.

To affect everything, we could try putting it as favicon.png in https://github.com/jj-vcs/jj-vcs.github.io. (We might have to experiment, I'm not sure whether it needs to be ICO or can be PNG). The comment about the size applies to that too.

docs/favicon.png Outdated Show resolved Hide resolved
LICENSE Outdated Show resolved Hide resolved
@jennings
Copy link
Contributor

I’ll get you a bigger PNG and SVG tomorrow, the file sent over Discord will probably be artifacty. I just need to make sure there’s no gross metadata in the files before I put them on the internet.

I think this is the favicon generator I’ve used in the past, I recall there being weird platform quirks about getting the high quality versions to show up everywhere. This may be overkill for the docs site though.

@jennings
Copy link
Contributor

jennings commented Jan 28, 2025

I don't trust Discord so I pushed a full size image here to a branch.

The SVG that Canva exports isn't really vector art, it just has the base64-encoded PNG inside it.

@martinvonz
Copy link
Member Author

Thanks! I uploaded that image to the favicon generator you linked to. I added the same background color as we use elsewhere. Then I took the generated favicon.ico file and put in the repo. I hope that's what I was supposed to do. The GitHub UI doesn't render the favicon file but hopefully most browsers understand the format.

@jennings
Copy link
Contributor

I think ico is deprecated for favicons, it’s there as a last resort. All modern browsers will use the higher quality PNG versions if the link tags exist for it.

Let me give it a try soon and post a suggested here?

I suppose it would be find to merge as is and improve it later.

@martinvonz
Copy link
Member Author

Let me give it a try soon and post a suggested here?

Thanks. I'll wait.

@jennings
Copy link
Contributor

Oh I see, MkDocs doesn't have a great way to add extra <link> elements to the page header without extending the theme, which we don't do yet.

The only change I would probably make, then, is to use the 96x96 PNG that the favicon generator spits out, instead of an ICO file. Comparing the quality:

image

@martinvonz
Copy link
Member Author

Done

@martinvonz
Copy link
Member Author

@ilyagr and @jennings, are you okay with the current version?

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

Successfully merging this pull request may close these issues.

3 participants