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

Missing Awesome badge after the main heading #109

Open
thisismydesign opened this issue Jun 4, 2020 · 3 comments
Open

Missing Awesome badge after the main heading #109

thisismydesign opened this issue Jun 4, 2020 · 3 comments

Comments

@thisismydesign
Copy link

The following file fails linting: https://github.com/componently-com/awesome-building-blocks-for-web/blob/4cc6f199c84ef43453d73a5c0dae314d50754fee/README.md

https://github.com/componently-com/awesome-building-blocks-for-web/runs/739746789?check_suite_focus=true#step:4:11

I'm not sure why, are there any good-bad examples or docs I missed? ToC was generated with doctoc.

@thisismydesign
Copy link
Author

To make this one pass I needed to put the badge in the same line as the title. I don't see how https://github.com/sindresorhus/awesome-nodejs should pass but having the badge in a new line shouldn't. Feel free to close though if you don't think it's an issue.

@sindresorhus
Copy link
Owner

I think this is already pretty clear in the Awesome guidelines:

Includes the Awesome badge.
Should be placed on the right side of the readme heading.
Can be placed centered if the list has a centered graphics header.

@thisismydesign
Copy link
Author

I didn't make the connection, perhaps it would make sense to show the list of requirements in this repo as well?

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

No branches or pull requests

2 participants