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

Allow inlining img with github-stars class #71

Conversation

kaushalmodi
Copy link
Contributor

Discussion: https://discourse.gohugo.io/t/how-to-update-css-for-hugodocs-for-a-pr/8641

This PR is in preparation for another PR on the hugoDocs repo. I am proposing adding a ghstars shortcode to the hugoDocs repo, which shows an svg image with star count for a GitHub repo. The SVG is generated dynamically by https://shields.io.

Without this PR, all images in nested-img class show in a new paragraph (block display) and fit the container width (100% width).

You can find my detailed reply here, but this is the end result I am looking for:

img

@maiki
Copy link

maiki commented Oct 2, 2017

Pretty cool shortcode. 😄

I don't think there is any value to social proofing those links, and that is the only value I think adding the stars provides. It is also abrupt, and distracting. But that's my opinion.

A greater concern is adding complexity to the maintenance of the docs. Each shortcode used is to provide a convenient and hopefully self-evident shortcut to adding content to the site. Not everyone uses GitHub, and not all the tools on that page will have stars worth mentioning. If we want to encourage folks to be bold and add to the docs, we ought to make it as simple as possible.

Also, I am not a fan of loading dynamically created images into documentation. No need for shields.io to track visitors to the site.

@kaushalmodi
Copy link
Contributor Author

That's convincing. I'll close the PR.

@kaushalmodi kaushalmodi closed this Oct 2, 2017
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.

2 participants