DEV Community

Discussion on: What was your win this week?

Collapse
 
shhdharmen profile image
Dharmen Shah

I created a small side project:

GitHub logo shhdharmen / github-link

⚓ Get links to code in your GitHub files based on text, and forget the line numbers!

GitHub Link

GitHub Link

Get links for your GitHub files based on text, and forget the line numbers!

All Contributors

Why GitHub Link?

In Short

We usually create link-to-code to point our readers, users or developers to the exact code. But such links are created based on line-number and if you're updating the file regularly, those links will not point to correct line or you will need to keep updating your links. GitHub Link helps you to get the right link-to-code, based on text you give, so that it always points to contextually right definition. Jump to usage

In Long

We generally create permanent link to code snippet. As they are for specific commit, they work great when referred in issues/PRs.

But what if you want to give such links in your README or such files? Like you have already defined a coded file with proper comments and you want to give link to…




Collapse
 
sheikhrashed profile image
Sheikh Rashed

great