Add logo and banner #277
Add logo and banner #277
Conversation
docs/_config.yml
Outdated
| @@ -6,3 +6,5 @@ url: https://UCL-ARC.github.io/python-tooling | |||
|
|
|||
| aux_links: | |||
| Source repository: https://github.com/UCL-ARC/python-tooling | |||
|
|
|||
| logo: "https://raw.githubusercontent.com/UCL-ARC/python-tooling/main/images/logo.png" | |||
There was a problem hiding this comment.
I couldn't get a relative path to work locally so used full URL - not sure if we could put images somewhere under docs directory to get this working and/or if there are relevant Jekyll / theme configuration options.
There was a problem hiding this comment.
Possibly the images are not included in the artifact upload step (therefore not included in the website deployment??).
I'd say this way is probably fine.
There was a problem hiding this comment.
I think you have to do this kind of thing for relative links https://github.com/paddyroddy/paddyroddy.github.io/blob/347e094cb0af0c609394b2beaa90770929feca1e/running.html#L14.
I think your approach is fine, though.
There was a problem hiding this comment.
Thanks useful to know for future reference!
| max-height: 15em; | ||
| height: 15em; |
There was a problem hiding this comment.
As max-height attribute is set in theme styling found I needed to override both max-height and height for this to work but someone with more CSS knowledge may know a better approach.
images/logo.png
Outdated
There was a problem hiding this comment.
We could potentially remove this. I initially thought it might be necessary to have a raster image for including in theme but rendering SVG directly works. It can be useful to have a PNG for some use cases but easy enough to just generate from SVG.
This reverts commit 2ea85c9. Removing logo from README for now in favour of adding in separate PR.
images/banner.svg
Outdated
There was a problem hiding this comment.
Should it go at the top of the README? We can replace the title with the banner, right?
There was a problem hiding this comment.
Having the logo in the README seems a good idea though from a digital accessibility standpoint might be better to have title still as text (though I guess alt text would somewhat solve that). Could have logo above header / title - something like https://github.com/matt-graham/symnum?
There was a problem hiding this comment.
Could have logo above header / title - something like matt-graham/symnum?
That looks nice
There was a problem hiding this comment.
I've had a go at replicating this in the README - unfortunately to get image to be centre aligned need to fallback to HTML rather than Markdown. I've also centred the heading at the moment but could keep this left aligned and just centre logo. As the image URL includes the branch and the logo is not currently on main (and I guess we don't want to keep this branch around) this won't currently render correctly until merged.
There was a problem hiding this comment.
Oh and the image not existing yet is causing the link checker to fail. I guess probably worth separating out in a different PR - will revert here.
|
🫐 |
|
I made an aborted attempt to include a favicon version of logo as noticed Jekyll complained about not being able to find |
|
I'm happy, merging |
Follow on from #277 - adds logo to README file. Hopefully link checker will now not fail as logo file now on `main` 🤞.
Following on from #144, adds SVG files for logo we decided on in meeting today to a new
imagessubdirectory plus a corresponding social banner to address task in #246. The text colour on the banner should be visible on both dark and light backgrounds.I've also configured the Jekyll site to show the logo in the header bar - by default this was very small so I've added some custom (S)CSS to adjust the header div size and center the logo.
Currently only the logo is shown in the header not any text - not sure if it is possible to override this?