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

Please add syntax documentation to each badge popup #466

Closed
kavdev opened this issue Jun 8, 2015 · 5 comments
Closed

Please add syntax documentation to each badge popup #466

kavdev opened this issue Jun 8, 2015 · 5 comments
Labels
frontend The Docusaurus app serving the docs site

Comments

@kavdev
Copy link

kavdev commented Jun 8, 2015

I've had some difficulty decoding the syntax for some of the badges. It'd be great to see some sort of syntax documentation on the "build badge" popup, possibly right below the "image" line.

Example: Travis:
syntax: https://img.shields.io/travis/<username>/<project>.svg

@espadrine
Copy link
Member

The popup shows the real URL for the badge clicked on. We could put the syntax information directly on the right; it's really meant as an inline syntax documentation anyhow. In some cases, the actual example is more explanatory (knowing we must put a token isn't as helpful as knowing what the token looks like).

If you want to contribute changes in this regard, you may do so in try.html.

@kavdev
Copy link
Author

kavdev commented Jun 9, 2015

Okay. I'll get started later this week.

@kavdev
Copy link
Author

kavdev commented Jun 17, 2015

I looked at this over the weekend and found that it will take quite a bit of time (time I don't currently have). I'll comment here when I find time to work on this. For now, you can either set this to on hold or close it and I'll reopen it when I'm ready.

@paulmelnikow
Copy link
Member

Related: #701, #777, #776

@paulmelnikow
Copy link
Member

Closing in favor of #701.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
frontend The Docusaurus app serving the docs site
Projects
None yet
Development

No branches or pull requests

3 participants