search

sindresorhus / awesome-lint

Linter for Awesome lists
MIT License
599 stars 55 forks source link

Missing Awesome badge after the main heading #109

Open thisismydesign opened 4 years ago

thisismydesign commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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