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

logo: simplify basic usage, allow for extended functionality #679

Open
cagix opened this issue Oct 6, 2023 · 4 comments
Open

logo: simplify basic usage, allow for extended functionality #679

cagix opened this issue Oct 6, 2023 · 4 comments
Assignees
Labels
feature New feature or request

Comments

@cagix
Copy link

cagix commented Oct 6, 2023

Currently, to use your own logo, you first have to define a custom partial "layouts/partials/logo.html" and reference an image or the like there (see https://mcshelby.github.io/hugo-theme-relearn/basics/customization/index.html#change-the-logo).

This works, but is rather cumbersome for users. Could a similar solution be implemented for logos like for favicons? I.e. as default, an image file called "logo.png" (or logo.svg) is searched for in the folder "static/images/" and if I have other needs, I need to create the extra partial?

This way, the logo and the favicon would be treated symmetrically.

@McShelby
Copy link
Owner

McShelby commented Oct 7, 2023

I am hesitant.

For the logo this is rather difficult, because it's not only the logo to display but posibliy a title, too. This title may or may not be given in the logo image but as separate text.

While the first case often result in a rectangualar logo, the latter usually (but not always) results in a squarish logo.

Also, often there are font requirements for the logo title, if given as text - as well as color requirements if a light or dark style was selected.

This is only an incomplete list of some of the options. I could go on and on...

Even if only a stripped down solution is implemented in the theme itself, I bet it would end up in a lot of support questions.

It's not off the table, but I have to think about it.

@McShelby McShelby added feature New feature or request undecided No decission was made yet labels Oct 7, 2023
@cagix
Copy link
Author

cagix commented Oct 7, 2023

Well, I see two use cases here: (a) I have just a logo (image), and (b) I need something fancier (e.g. logo plus text or some extra formatting).

  • In the first case (simple logo/image) it would be much easier for your users - they just need to store the image file to a certain location using a certain name. No need for extra custom partials ...
  • In the second case it's just the current way and users have to implement their custom partial.

Edit: This would also be backwards compatible, i.e. won't break any existing setups :)

@McShelby McShelby removed the undecided No decission was made yet label Nov 20, 2023
@McShelby McShelby self-assigned this Nov 20, 2023
@McShelby McShelby added this to the 5.24.0 milestone Nov 20, 2023
@McShelby
Copy link
Owner

I started working on this. But as I expected, this ends in some extensive (but backwards compatible) changes to do it "right".

@McShelby McShelby changed the title logo: use "static/images/logo.png" as default if no custom "layouts/partials/logo.html" exists logo: simplify basic usage, allow for extended functionality Nov 20, 2023
McShelby added a commit that referenced this issue Nov 20, 2023
currently only the additional name option is recognized
McShelby added a commit that referenced this issue Nov 20, 2023
McShelby added a commit that referenced this issue Nov 21, 2023
McShelby added a commit that referenced this issue Nov 23, 2023
McShelby added a commit that referenced this issue Nov 25, 2023
McShelby added a commit that referenced this issue Nov 26, 2023
McShelby added a commit that referenced this issue Nov 26, 2023
McShelby added a commit that referenced this issue Dec 3, 2023
McShelby added a commit that referenced this issue Dec 3, 2023
@McShelby McShelby removed this from the 5.24.0 milestone Feb 12, 2024
McShelby added a commit that referenced this issue Feb 12, 2024
@McShelby
Copy link
Owner

McShelby commented Feb 12, 2024

While the groundwork was layed in 5.24.0 to make the icon configurable, the finishing step was postponed to a later release due to time constraints.

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

No branches or pull requests

2 participants