how to hyperlink in readme code example
Example 1: how to create link in readme.md
[a link] (https://github.com/user/repo/blob/branch/other_file.md)
Example 2: adding link to heading readme.md
/*
Here is javascript code for automatically getting link attached to content of readme.md file.
Full Code - https://gist.github.com/SBZed/490f5d9eac525de02f610a28f0c9453c
*/
LinkHeadingToContent(headingText) {
headingList = headingText.split('\n');
headingList.map((heading, index) => {
const firstDigitIndex = heading.search(/\d/);
const anchorText = heading
.toLowerCase()
.replace(/[^a-z\d\s]/g, '')
.trim()
.replace(/ /g, '-');
headingList[index] =
[heading.slice(0, firstDigitIndex), '[', heading.slice(firstDigitIndex)].join('') +
'](#' +
anchorText +
')';
});
return headingList.join('\n');
}