CODEWITHSUNDEEP
githubhyperlinkmarkdown
Dave
Dave

Reputation: 7623

Placing links inside markdown code blocks

I want to have links inside my code blocks using GitHub flavored markdown.

```cpp
void Click ([Keycode](#keycode) key) const
```

Unfortunately, it renders that as code, anyway to make it a link instead?

Upvotes: 74

Views: 42490

Answers (5)

Giacomo Marciani
Giacomo Marciani

Reputation: 442

This makes the trick.

I use it on my GitHub profile page to put links inside code blocks.

<pre>
 <code>
  <a href="https://github.com/gmarciani">gmarciani</a>
 </code>
</pre>

Upvotes: 5

mlissner
mlissner

Reputation: 18206

You can do this using HTML in markdown, yes, even on Github:

<pre>
<a href="my-url">Something</a>
</pre>

Upvotes: 17

Kelvin
Kelvin

Reputation: 553

If its a short piece of code this should do the trick:

[`this is code`](https://this_is_url/)

Upvotes: 48

Dave
Dave

Reputation: 7623

As suggested by VonC, it might not be possible with the current version of GitHub Flavored Markdown. That being said, I did find a way around it which suits my requirements. By using tags like <big>, <pre> and <b> I'm able to simulate syntax highlighting and get the effect I'm looking for. Too bad I can't add my own color though.

<big><pre>
**void** Click ([**Keycode**](#keycode) key) **const**
</pre></big>

Upvotes: 21

VonC
VonC

Reputation: 1328272

As far as I know, the current instance of GitHub Flavored Markdown doesn't support this.

The all block is rendered with <div class="highlight highlight-html"><pre>... </pre></div>, meaning your markdown link is not interpreted.

It would be best to place that link just before the code section (unless said section has dozens of similar links in your code).

Upvotes: 25

Related Questions