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

Adding Product Logo in sidebar #283

Open
usta opened this issue Jul 5, 2021 · 15 comments
Open

Adding Product Logo in sidebar #283

usta opened this issue Jul 5, 2021 · 15 comments
Labels
good-first-issue Good for newcomers Hacktoberfest Issues that are good first picks for Hacktoberfest participants

Comments

@usta
Copy link
Member

usta commented Jul 5, 2021

It will be nice to add a new part for tools sections called productLogo or logo so
we can put logos with svg formated logo links ( which must be creative common or any open license) that will improve its look visually

@welcome
Copy link

welcome bot commented Jul 5, 2021

Thanks for opening your first issue here! Be sure to follow the issue template!

@usta usta changed the title Adding Product Logo to pages Adding Product Logo to tools Jul 5, 2021
@usta
Copy link
Member Author

usta commented Jul 5, 2021

@captn3m0 @BiNZGi ^^

@usta
Copy link
Member Author

usta commented Jul 5, 2021

I have mentioned as svg which will help us to decide its resolution without losing its quality while rendering

@usta
Copy link
Member Author

usta commented Jul 5, 2021

also we can use same svg with rendering it as 32x32 in site-nav part so it will help people to select tools much easier

@hugovk
Copy link
Member

hugovk commented Jul 5, 2021

https://simpleicons.org/ is a good source of CC0 SVG icons, they're also used by https://shields.io/

@captn3m0
Copy link
Member

captn3m0 commented Jul 5, 2021

Simpleicons looks neat. I was also thinking of incorporating icons in the generated visual timeline (small icon at bottom right of the timeline).

Are SVG icons usable as Favicons? Should we use product icons for favicons?

@usta
Copy link
Member Author

usta commented Jul 5, 2021 via email

@usta
Copy link
Member Author

usta commented Jul 9, 2021

I normally dont want to be "That" guy who always willing to be "grammar nazi"
but @captn3m0 isnt this looks better if we use same structure with other tags ?
I suggest using camelCase system instead of underscores.
I mean using iconSlug instead of icon_slug will be much suitable to keep everything in order

@captn3m0
Copy link
Member

Thanks for the note, will take care of it.

@usta
Copy link
Member Author

usta commented Jul 18, 2021

I think this one ^^ have forgotten :)

@captn3m0 captn3m0 changed the title Adding Product Logo to tools Adding Product Logo in sidebar Jul 21, 2021
@captn3m0
Copy link
Member

captn3m0 commented Sep 27, 2021

If you're working on this, you will need to extend the nav.html file as a include in our repository from the theme we are using: https://github.com/pmarsceill/just-the-docs/blob/master/_includes/nav.html.

Then, add the relevant HTML/CSS to add the icon to the sidebar to display the icon correctly. Make sure the design looks good (and well-aligned) even if we don't have an icon for the product.

See the icon bits in our product page template:

{% if page.iconSlug and page.iconSlug != "NA" %}
<img class=productlogo width=50 height=50 src="https://simpleicons.org/icons/{{page.iconSlug}}.svg" >
{% elsif page.iconSlug != "NA" %}
<img class=productlogo width=50 height=50 src="https://simpleicons.org/icons{{page.permalink}}.svg" >
{% endif %}
to make sure you're parsing the field the same way.

Read through very helpful guide for new contributors during Hacktoberfest as well to understand how to setup the project.

@captn3m0 captn3m0 added good first issue Hacktoberfest Issues that are good first picks for Hacktoberfest participants labels Sep 27, 2021
@sooraj-gk
Copy link

Sir, can I work on this issue

@captn3m0
Copy link
Member

Go ahead, thanks for letting us know 👍🏽

@ampsteric
Copy link

hey! , I would be happy to help.
Please assign me this issue under hacktoberfest.

@usta
Copy link
Member Author

usta commented Nov 7, 2022

looks like history repeats itself , first @sooraj-gk then @ampsteric
Ok , from now on please nobody asks for a assign this to me thing , just makes a MR/PR and we will
check if it is ok or not

@BiNZGi BiNZGi added good-first-issue Good for newcomers and removed good first issue labels Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue Good for newcomers Hacktoberfest Issues that are good first picks for Hacktoberfest participants
Projects
None yet
Development

No branches or pull requests

6 participants