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

Update README.md #45

Closed
wants to merge 1 commit into from
Closed

Update README.md #45

wants to merge 1 commit into from

Conversation

kingthorin
Copy link

@kingthorin kingthorin commented Jan 18, 2021

All the tables contain HTML syntax not markdown. While GitHub does support this it's better to be technically correct. Either this or all of the entries should be updated to use proper Markdown syntax:

![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)

Ex:

<img alt="Markdown" src="https://img.shields.io/badge/markdown-%23000000.svg?&style=for-the-badge&logo=markdown&logoColor=white"/>

would become:

![](https://img.shields.io/badge/markdown-black.svg?style=for-the-badge&logo=markdown)

Also note every entry seems to have a mistake in the parameters with ?& instead of simply ? for the first param, luckily shields.io does parse this properly but you should likely fix it. Last, you should probably clarify style=for-the-badge or just not specify it.

Ref: https://guides.github.com/features/mastering-markdown/

All the tables contain HTML syntax not markdown. While GitHub does support this it's better to be technically correct. Either this or all of the entries should be updated to use proper Markdown syntax:
```md
![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)
```
@Ileriayo
Copy link
Owner

Hey @kingthorin,

I think you have a great point there.
However, it is best to raise an issue for this and not a PR.
What do you think?

@kingthorin
Copy link
Author

Ya I understand. I did the first set of changes (the headings) then noticed other things as I was working with the file.

Do you want 3 separate issues? Or just one with 3 bullets?

  • Syntax HTML vs Markdown.
  • Parameter separator mistake.
  • Style param.

@Ileriayo
Copy link
Owner

There's no strict rule for this.
However, I guess it makes more sense if issues target specific things.
This will allow contributors solve specific only what they are able to rather than trying to solve all problems at once.

@kingthorin
Copy link
Author

Done x3 😀

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.

None yet

2 participants