GitHub Autolinks

裸の Issue 番号、クロスリポジトリ参照、コミット SHA を GitHub へ自動リンクします。

GitHub Autolinks 機能は、GitHub の Issue・プルリクエスト・コミットへの裸の参照を、設定したリポジトリを指す実際のハイパーリンクに変換します。本文に #123 と書くだけで、その Issue へのリンクになります。手動で URL を書く必要はありません。

// zfb.config.ts export default defineConfig({ markdown: { features: { githubAutolinks: { repo: "zudolab/zudo-doc", }, }, }, });

認識される形式

3 つの参照形式が自動リンクされます。zudo-doc は repo: "zudolab/zudo-doc" を設定しているため、以下の例のデフォルトリポジトリは zudolab/zudo-doc です。

ライブデモ

以下の各参照はプレーンな本文なので、ビルド時にリンクへ変換されます。ホバーまたはクリックしてリンク先を確認してください。

• 裸の Issue 参照: #456 は設定リポジトリの Issue 456 へリンクします。

• クロスリポジトリ参照: zudolab/zudo-doc#123 はそのリポジトリの Issue 123 へリンクします。

• コミット SHA: 1234567890abcdef1234567890abcdef12345678 はそのコミットへリンクします。

スコープ

• インラインコード（`#123`）やフェンスコードブロック内の参照は変換されません。上の表の構文がそのまま文字として残るのはこのためです。

• すでにアンカータグで囲まれているテキストはそのまま残し、二重リンクを防ぎます。

• クロスリポジトリ参照は、グローバルに設定した repo ではなく、自身に埋め込まれた owner/repo を使います。

• 純粋な数字の並びはコミットハッシュではなく、ただの数値として扱われます。