バックリンク（Backlink）

公開済みのどのノートが現在のノートにリンクしているかを示す、バックリンクの一覧表示です。getPublishedBacklinks()がコンテンツマニフェストから被リンクを解決し、公開されて検出可能なノートだけに絞り込んで、マニフェストの順序で並べます。

推奨する配置

backlinks()がデータソースを登録します。一覧を置きたい場所に<Backlinks />を描画します。通常は記事本文のあとに1回だけ置きます。SiteProviderと、公開されたentryを持つArticleの内側では、コンポーネントが被リンクを自分で解決します。

被リンクがない場合（または公開された被リンクが1つもない場合）、コンポーネントは何も描画しません。

高度なカスタマイズ

backlinksでデータを明示的に渡します。getBacklinks({ view, slug })で解決できます。

import { Backlinks, getBacklinks } from "@riebeckite/plugin-backlinks";
 
const backlinks = await getBacklinks({ view, slug });
 
return (
  <aside>
    <Backlinks backlinks={backlinks} />
  </aside>
);

設定

plugins: [backlinks()];

プラグインを有効にし、コンポーネントを1回描画します。UIをなくすには要素を取り除きます。

バックリンクデータの解決

getPublishedBacklinks()関数は、コンテンツマニフェストから被リンクを解決します。次のオプションを受け取ります。

manifest：コンテンツシンクから得たContentManifest
config：解決済みのResolvedRiebeckiteConfig
slug：現在のノートのslug
resolveTitle：エントリのタイトルを解決する関数(slug: string, title: unknown) => string

戻り値はArticleBacklink[]で、各要素はslug、permalink、titleを持ちます。リンクは公開されて検出可能なエントリだけに絞り込まれ、マニフェストの順序で並びます。

import { getPublishedBacklinks, content } from "@riebeckite/plugin-backlinks";
import { getArticleTitle } from "../lib/article-title";
 
const manifest = await content.getManifest();
const backlinks = getPublishedBacklinks({
  manifest,
  config,
  slug: "my-note",
  resolveTitle: getArticleTitle,
});

さらに詳しく

Backlinks

CurrentOutgoingBacklink