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

readthedocs icon not working #3639

Closed
1 of 3 tasks
peterjc opened this issue Jul 3, 2019 · 4 comments
Closed
1 of 3 tasks

readthedocs icon not working #3639

peterjc opened this issue Jul 3, 2019 · 4 comments
Labels
question Support questions, usage questions, unconfirmed bugs, discussions, ideas

Comments

@peterjc
Copy link

peterjc commented Jul 3, 2019

Are you experiencing an issue with...

🪲 Description

Trying to show a ReadTheDocs status, like:

🔗 https://img.shields.io/readthedocs/thapbi-pict.svg

But with the readthedocs logo fails:

🔗 https://img.shields.io/readthedocs/thapbi-pict.svg?logo=readthedocs
🔗 https://img.shields.io/readthedocs/thapbi-pict.svg?logo=ReadTheDocs

Other simpleicons work:

https://img.shields.io/readthedocs/thapbi-pict.svg?logo=Adobe
https://img.shields.io/readthedocs/thapbi-pict.svg?logo=let%E2%80%99s-encrypt

Built in logos do work, e.g.

🔗 https://img.shields.io/readthedocs/thapbi-pict.svg?logo=travis
🔗 https://img.shields.io/readthedocs/thapbi-pict.svg?logo=appveyor

💡 Unsure where in the code to start looking

@peterjc peterjc added the question Support questions, usage questions, unconfirmed bugs, discussions, ideas label Jul 3, 2019
@calebcartwright
Copy link
Member

calebcartwright commented Jul 3, 2019

The icon reference is read-the-docs with - between the words. I believe that's the general convention used by simple icons for multi-word references, but I wish they could make that more clear in their docs.

https://img.shields.io/readthedocs/thapbi-pict.svg?logo=read-the-docs

@calebcartwright
Copy link
Member

Closing this as the icon works with correct icon reference, please feel free to reopen @peterjc if you feel otherwise!

@peterjc
Copy link
Author

peterjc commented Jul 3, 2019

No, that's fair. It was my mistake

On re-reading, https://shields.io/category/build says:

?logo=appveyor
Insert one of the named logos from (bitcoin, dependabot, discord, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. Simple-icons are referenced using names as they appear on the simple-icons site. If the name includes spaces, replace them with dashes (e.g: ?logo=visual-studio-code)

So yes, it does say lower case with dashes - evidently having looked at https://simpleicons.org/?q=read%20the%20docs and the name of the download being readthedocs.svg I must have assumed that's what you mean by "as they appear on the simple-icons site". Oops.

Thanks for the quick pointer at the expected solution.

@paulmelnikow
Copy link
Member

Feel free to upvote simple-icons/simple-icons#1362, which I think would make this process easier for everyone!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Support questions, usage questions, unconfirmed bugs, discussions, ideas
Projects
None yet
Development

No branches or pull requests

3 participants