コードスニペットへのパーマリンクを作成する

特定バージョンのファイルやプルリクエストにある特定のコード行やコード行の範囲へのパーマリンクを作成できます。

この機能を使用できるユーザーについて

Markdown は、GitHub Web インターフェイスで使用できます。

この記事の内容

コードへのリンク

このタイプのパーマリンクは、元々作成された場所であるリポジトリでのみ、コードスニペットとして表示されます。 それ以外のリポジトリでは、パーマリンクのコードスニペットは URL として表示されます。

issue コメントのスクリーンショット。 コード スニペットには、ファイル名と行番号を示すヘッダーと、それらの行のコードを一覧表示する本文があります。

Tip

ファイル全体のパーマリンクの作成については、「ファイルへのパーマリンクを取得する」を参照してください。

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リンクしたいコードを特定します:

    • ファイルからコードにリンクするには、対象のファイルに移動します。
    • pull request からコードにリンクするには、対象の pull request に移動して [変更されたファイル] をクリックしてください。 次に、コメントに取り込むコードが含まれているファイルを参照し、 View をクリックします。

  3. 1 行または範囲のどちらを選ぶかを選びます。

    • コードを１行選択するには、行番号をクリックしてその行をハイライトしてください。
    • コードの範囲を選択するには、その範囲の先頭行の番号をクリックしてコードのその行をハイライトしてください。 そしてコードの範囲の最終行までポインタを移動させ、Shift を押し、行番号をクリックして範囲をハイライトします。

  4. 行または行範囲の左にある をクリックします。 ドロップダウン メニューの [Copy permalink]/(パーマリンクのコピー/) をクリックします。

    ファイルのスクリーンショット。8 行が選ばれています。 選ばれている最初の行の左側には、ケバブ アイコンというラベルが付いたボタンが濃いオレンジ色の枠線で囲まれています。

  5. コードスニペットにリンクさせたい会話に移動します。

  6. パーマリンクをコメントに貼り付け、 Comment をクリックします。

Markdown へのリンク

Markdown のレンダリングなしで Markdown ファイルを読み込むことにより、Markdown ファイルの特定の行にリンクすることができます。 レンダリングなしで Markdown ファイルを読み込むには、ファイルの URL の最後で ?plain=1 パラメーターを使います。 たとえば、「 github.com/<organization>/<repository>/blob/<branch_name>/README.md?plain=1 」のように入力します。

コード内で行うのと同じ方法で、Markdown ファイルの特定の行にリンクすることができます。 URL の最後に、行番号 (複数可) と一緒に #L を追加します。 たとえば、github.com/<organization>/<repository>/blob/<branch_name>/README.md?plain=1#L14 はプレーンな README.md ファイルの 14 行目を強調表示します。

参考資料