Skip to content

creating-a-permanent-link-to-a-code-snippet.md

Latest commit

 

History

History
48 lines (37 loc) · 3.13 KB

creating-a-permanent-link-to-a-code-snippet.md

File metadata and controls

48 lines (37 loc) · 3.13 KB
title Creating a permanent link to a code snippet
intro You can create a permanent link to a specific line or range of lines of code in a specific version of a file or pull request.
product {% data reusables.gated-features.markdown-ui %}
redirect_from
/github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/creating-a-permanent-link-to-a-code-snippet
/articles/creating-a-permanent-link-to-a-code-snippet
/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet
/github/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet
versions
fpt ghes ghec
*
*
*
shortTitle Permanent links to code
category
Write and format content

Linking to code

This type of permanent link will render as a code snippet only in the repository it originated in. In other repositories, the permalink code snippet will render as a URL. This does not work in Markdown files, only in comments.

Screenshot of an issue comment. A code snippet has a header that lists the file name and line numbers, and a body that lists the code on those lines.

Tip

To create a permalink for an entire file, see AUTOTITLE.

{% data reusables.repositories.navigate-to-repo %}

  1. Locate the code you'd like to link to:

    • To link to code from a file, navigate to the file.
    • To link to code from a pull request, navigate to the pull request and click {% octicon "diff" aria-hidden="true" aria-label="diff" %} Files changed. Then, browse to the file that contains the code you want to include in your comment, and click View. {% data reusables.repositories.choose-line-or-range %}

  2. To the left of the line or range of lines, click {% octicon "kebab-horizontal" aria-label="Code line X options" %}. In the drop-down menu, click Copy permalink.

    Screenshot of a file, with 8 lines selected. To the left of the first selected line, a button labeled with a kebab icon is outlined in dark orange.

  3. Navigate to the conversation where you want to link to the code snippet.

  4. Paste your permalink into a comment, and click Comment.

Linking to Markdown

You can link to specific lines in Markdown files by loading the Markdown file without Markdown rendering. To load a Markdown file without rendering, you can use the ?plain=1 parameter at the end of the URL for the file. For example, github.com/<organization>/<repository>/blob/<commit_SHA>/README.md?plain=1.

You can link to a specific line in the Markdown file the same way you can in code. Append #L with the line number or numbers at the end of the URL. For example, github.com/<organization>/<repository>/blob/<commit_SHA>/README.md?plain=1#L14 will highlight line 14 in the plain README.md file.

Further reading