Skip to content
This repository has been archived by the owner on Jan 21, 2022. It is now read-only.

fix: README link fixes & formatting #21

Merged
merged 1 commit into from
Jun 4, 2021
Merged

Conversation

igneel64
Copy link
Contributor

@igneel64 igneel64 commented Jun 3, 2021

Description

  • Review broken links
  • Autohighlight/Format code examples using the appropriate tag.
  • Blank target for third-party links

@nachoiacovino
Copy link

Doesnt' look like target="_blank" works on GitHub. I tried the commit here https://github.com/clerkinc/clerk-sdk-node/tree/6ddace8c502524e04d8bcb010cea1d8424780796 and they don't open on a new tab.

More info: https://stackoverflow.com/questions/41915571/open-link-in-new-tab-with-github-markdown-using-target-blank

We should try and see if there's another way to do it and if there isn't, we should revert those changes to make everything looks cleaner.

Copy link
Contributor

@yourtallness yourtallness left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#lgtm

@igneel64
Copy link
Contributor Author

igneel64 commented Jun 4, 2021

@nachoiacovino Thanks for your comment!

  • I would keep the formatting as it is since I would not consider GH as the only place markdown is parsed
  • Also if and when GH supports it, it will probably be in the format that the standard supports (which is HTML in MD).
  • For the clean part, I do not have any strong feel about it, the only thing is that the full link tag is more expressive.

@igneel64 igneel64 merged commit e0a5ddd into main Jun 4, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants