How to include a code snippet in a GitHub issue comment?

[UlyssesZh]

Select Topic Area

Question

Body

According to this doc, just pasting the permalink of the range of codes would be fine. However, when I tried that in this issue, the link was shown as is instead of showing a fancy code snippet. What did I do wrong?

[Matt-Osborn]

in general you can use back ticks (they are on the same key as the tilde ~ on most qwerty keyboards) - this works anywhere that renders markup. example

print("hello world")

also, for code blocks you can use three:

def function():
     print("this is an example")

[UlyssesZh]

You misunderstood me. This is the look I want to have:

[Matt-Osborn]

Yes I did misunderstand - and your right, it makes it sound like it should work in the same repo - which it looks like you are.

Maybe it works on 'comments' but not issues...

[UlyssesZh]

Look at my case. It is in the repository it originates in.

[Noahnoah55]

Just had a similar problem. You gotta remove the "C2" part from each line number. Also since you're just doing one line you might also want to just use L23 instead of L23-L23

Instead of https://github.com/audiojs/audio-decode/blob/83c3883f5a2505de50da880c7c58a516d4415793/package.json#L23C2-L23C2 you want https://github.com/audiojs/audio-decode/blob/83c3883f5a2505de50da880c7c58a516d4415793/package.json#L23

[ernstki]

With or without the C part of the anchor, as of this writing, this feature no longer works in issues or discussions. I've tried, using your exact example and one of my own.

[jaamarks]

Just had a similar problem. You gotta remove the "C2" part from each line number. Also since you're just doing one line you might also want to just use L23 instead of L23-L23

Instead of https://github.com/audiojs/audio-decode/blob/83c3883f5a2505de50da880c7c58a516d4415793/package.json#L23C2-L23C2 you want https://github.com/audiojs/audio-decode/blob/83c3883f5a2505de50da880c7c58a516d4415793/package.json#L23

This was helpful. Also, I learned that this extra CX portion is included when you try to drag your mouse to highlight the code. But if you click the number to the left of the code. Hold down shift. Click the actual number of the last line of code you want to highlight. Then copy permalink. This will give you a URL that will show the code you want when pasted in an issue.

[jcubic]

It looks like documented feature that doesn't work at all.

Or just the screenshot is misleading, something like this was working, I've seen code snippets in issues.

[ernstki]

Agreed if it ever did work, it's not currently functional in GitHub issues or discussions.

If you're used to how this works in Gitea or Forgejo (or perhaps how it once worked in GitHub, assuming GitHub did it first), you really miss this feature.

[cipher20000]

To include a code snippet in a GitHub issue comment:

• For inline code, wrap your code with single backticks, like print("hello world").
• For multi-line/code blocks, use triple backticks (```) before and after your code:

def my_function():
    print("example")

• For linking to a specific line/range in a file, copy the permalink and use the format ending in #Lnumber (like #L23). Remove 'C2' or similar column reference from the URL (only use #Lnumber or #Lstart-Lend). Sometimes, only the link will show.
• Screenshots are a useful alternative if the snippet doesn't display as expected.

Right now, GitHub sometimes does not render permalinks as embedded code in comments. In that case, use the code formatting methods above or attach an image. Hope this helps!

[jcubic]

The question is how to embed GitHub source code by adding link to the line range. It's part of GitHub documentation, but it doesn't work.

[monsterhxw]

See: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet#linking-to-code

[jcubic]

@monsterhxw yes, this is the documentation that doesn't work.

[HalfWhitt]

@jcubic I just came across this issue, because I was trying to link to a different repo and wasn't sure why it wasn't working. However, it does work fine for me when linking within the same repo. Perhaps you could share a literal example of a permalink you've tried pasting, and had it not work?

Edit: I tested out the URL fix suggested above (https://github.com/audiojs/audio-decode/blob/83c3883f5a2505de50da880c7c58a516d4415793/package.json#L23) on the original issue linked to, and it works for me.

Screenshot:

You can confirm whether it works for you or not by pasting it as a reply there and clicking "Preview", without necessarily posting it.

[jpstotz]

There is another blocker for displaying the code lines: if you have enabled git blame in the code view and then copy the link to one or more lines and paste it into an issue you don't get the code vierw. This is because the link doesn't start like

https://github.com/audiojs/audio-decode/blob/...

but

https://github.com/audiojs/audio-decode/blame/...

If you manually change the blame back to blob you get the code view.

[prashantkoirala465]

On GitHub, simply pasting a permalink to a line range does not automatically render a fancy embedded code snippet in issue comments.

The “rich code preview” (the boxed snippet view) only works in certain places like pull request descriptions, PR review comments, or when using the “Insert a suggestion” feature. Regular issue comments don’t auto-expand permalinks into code previews.

So you didn’t necessarily do anything wrong it’s just a limitation of where GitHub supports snippet embedding.

If you want to include code in an issue comment, the reliable way is to use Markdown code fences:

 ```language // your code here ``` 

Example:

 ```cpp int add(int a, int b) { return a + b; } ``` 

If you want to reference a specific line in a file, you can still paste the permalink, but it will stay as a normal link.

[HalfWhitt]

In my experience, it does work in comments on issues, as long as it's in the same repo. Does it not render for you? Does it vary between repos somehow?

[RAAZIA-YASIN6770]

To include a code snippet, you can use triple backticks (```) before and after your code. For example:

console.log("Hello World");

This will format it properly with syntax highlighting.

[RAAZIA-YASIN6770]

detailed:
You can include a code snippet in a GitHub issue or discussion by using triple backticks (```).

1. For Inline Code:
   Use a single backtick before and after the text: your-code-here

2. For a Code Block:
   Use three backticks before and after your code. You can also add the language name (like python, javascript, or html) after the first set of backticks for syntax highlighting:

def hello_world():
print("Hello, GitHub!")

3. Pro-Tip:
   You can also use the "Insert code" icon (< >) in the formatting toolbar above the comment box to automatically insert these backticks.

If this helps you, please consider marking this as the answer! 🚀

[HalfWhitt]

The question is about displaying a link to GitHub code as a snippet or "preview" of that code, not just code-formatting text in the post.

[Shreyas-S-809]

GitHub uses Markdown, so adding code is just formatting — no special buttons needed.

---

Inline code (for small things)

Use a single backtick

Example:

npm install

It shows up like: npm install

Good for commands, file names, variables, flags, etc.

---

Code block (the one you usually want)

Use three backticks before and after the code.

```
your code here
```

---

With syntax highlighting (much nicer)

Add the language name right after the first three backticks.

```python
def hello():
    print("Hello world")
```

GitHub will color it automatically.

Common ones:

• js / javascript
• ts
• python
• bash / sh
• json
• yaml
• cpp
• java

---

Pro tip (people miss this)

If your code itself contains backticks, wrap it with four backticks outside:

````
```
actual code that has backticks
```
````

---

That’s it — GitHub comments, issues, PRs, discussions all follow the same rules.

[HalfWhitt]

That's not what this question is about. The four backticks thing is good to know, though.

[Dhilipkumar-max]

Hi,

When you paste a permalink to a specific range of code, GitHub only renders it as a rich code snippet preview in certain contexts. In many cases (including some issues and discussions), the link will remain a normal URL instead of expanding automatically.

A few things to check:

Make sure the link is a permalink to a specific commit, not to a branch (e.g., main). You can generate a true permalink by pressing y while viewing the file on GitHub.

Ensure the link includes the line range (for example: #L10-L25).

The preview only works when the link is pasted on its own line (not embedded inside text or backticks).

If all of the above are correct and it still doesn’t expand, it may simply be a limitation of the context where you’re posting. GitHub does not always render rich previews inside issues or certain discussion views.