@riebeckite/plugin-backlinks 0.0.32 → 0.0.33

package/README.md

@@ -7,8 +7,12 @@ current note.
 
 [日本語](./README_ja.md)
 
+## Live example
+
+Open [Backlink](/docs/glossary/backlink) to see the rendered Backlinks section at the bottom of an article that other pages link to.
+
 ## Recommended placement
-`backlinksPlugin()` provides a `getBacklinks({ view, slug })` helper that returns
+`backlinks()` provides a `getBacklinks({ view, slug })` helper that returns
 `readonly ArticleBacklink[]` (`{ slug, permalink, title }`) and a `<Backlinks
 backlinks={...} />` component that renders a `<footer class="rr-backlinks">` with
 an eyebrow label and a list of links. The Site places the `<Backlinks />`
@@ -23,15 +27,15 @@ renders nothing.
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { backlinksPlugin } from "@riebeckite/plugin-backlinks";
+import { backlinks } from "@riebeckite/plugin-backlinks";
 
 export default defineConfig({
   // ...
-  plugins: [backlinksPlugin()],
+  plugins: [backlinks()],
 });
 ```
 
-`backlinksPlugin()` adds backlinks for every public entry with published
+`backlinks()` adds backlinks for every public entry with published
 incoming links and bundles `style.css` into the app stylesheet. Render
 `<Backlinks backlinks={getBacklinks({ view, slug })} />` once in the article
 layout to display it. The official Starter already renders this component.
@@ -58,7 +62,7 @@ return (
 
 ## Configuration
 
-There are no plugin options for `backlinksPlugin`. The `Backlinks` component
+There are no plugin options for `backlinks`. The `Backlinks` component
 accepts `backlinks` as a required prop.
 
 ## Component
@@ -68,7 +72,7 @@ an eyebrow label and a list of links to each backlink's resolved `permalink`.
 
 ## Exports
 
-- `backlinksPlugin()` — plugin factory
+- `backlinks()` — plugin factory
 - `Backlinks` — list component (default export of `components/backlinks.tsx`)
 - `getBacklinks({ view, slug })` — resolves published backlinks for a slug
   (`{ slug, permalink, title }` each)

package/README_ja.md

@@ -2,31 +2,35 @@
 
 <!-- Generated from docs/docs/plugins/backlinks.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-現在の記事を参照している公開済みノートを、記事末尾に表示するためのプラグインです。
+現在の記事を参照している公開済みノートを一覧表示するプラグインです。
 
 [English](./README.md)
 
+## 実行例
+
+[Backlink](/ja/docs/glossary/backlink) を開くと、他のページからリンクされている記事の末尾に、Backlinks セクションが描画されています。
+
 ## 推奨配置
 
-`backlinksPlugin()` はコンテンツマニフェストから被リンクを集め、公開対象のノートだけをマニフェスト順で `<Backlinks backlinks={getBacklinks({ view, slug })} />` へ渡します。物理的な配置は Site が所有し、通常は記事本文の後でこのコンポーネントを一度描画します。`Backlinks` コンポーネントはその結果をリンク一覧として描画します。表示対象がなければ何も出力しません。
+`backlinks()` はコンテンツマニフェストから被リンクを解決する `getBacklinks({ view, slug })` と、その結果を描画する `<Backlinks backlinks={...} />` コンポーネントを提供します。`getBacklinks()` は公開対象のノートだけを残し、マニフェスト順で返します。`Backlinks` は受け取った一覧をリンク集として描画し、表示対象がなければ何も出力しません。配置はサイト側が担当し、通常は記事本文の後でこのコンポーネントを一度描画します。
 
 ## クイックスタート
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { backlinksPlugin } from "@riebeckite/plugin-backlinks";
+import { backlinks } from "@riebeckite/plugin-backlinks";
 
 export default defineConfig({
   // ...
-  plugins: [backlinksPlugin()],
+  plugins: [backlinks()],
 });
 ```
 
-プラグインは公開済みの被リンクがある記事へ自動的に出力を追加します。記事レイアウトで `<Backlinks backlinks={getBacklinks({ view, slug })} />` を一度描画してください。公式 Starter はこのコンポーネントをすでに描画しています。
+プラグインを有効にすると、公開済みの被リンクがある記事で `getBacklinks()` が一覧を返すようになります。記事レイアウトで `<Backlinks backlinks={getBacklinks({ view, slug })} />` を一度描画してください。公式 Starter はこのコンポーネントをすでに描画しています。
 
 ## 高度なカスタマイズ
 
-アプリ側で表示位置を決める場合は、`getBacklinks({ view, slug })` を呼び出してデータを取得し、 `<Backlinks backlinks={...} />` コンポーネントを一度だけ描画してください。データの生成と公開境界のフィルタリングは維持されます。
+アプリ側で表示位置を決める場合は、`getBacklinks({ view, slug })` を呼び出してデータを取得し、`<Backlinks backlinks={...} />` コンポーネントを一度だけ描画してください。被リンクのデータと公開範囲のフィルタリングは変わりません。
 
 ```tsx
 import Backlinks, { getBacklinks } from "@riebeckite/plugin-backlinks";
@@ -37,18 +41,18 @@ const items = getBacklinks({ manifest, config, slug, resolveTitle });
 return <Article footerContent={<Backlinks backlinks={items} />} />;
 ```
 
-手動配置を消すにはコンポーネントを消します。自動描画を有効にしたまま同じコンポーネントを描画すると重複します。
+`<Backlinks />` を複数回描画すると、同じ一覧が重複して表示されます。
 
 ## 設定
 
-`backlinksPlugin()` にはプラグイン用のオプションがありません。`Backlinks` コンポーネントは `backlinks` 必須プロップを受け取ります。
+`backlinks()` にはプラグイン用のオプションがありません。`Backlinks` コンポーネントは `backlinks` 必須プロップを受け取ります。
 
 ## 公開 API
 
-- `backlinksPlugin()`：プラグインファクトリ
+- `backlinks()`：プラグインファクトリ
 - `Backlinks`：被リンク一覧コンポーネント
 - `getBacklinks({ view, slug })`：公開済みの被リンクを解決する関数
-- `ArticleBacklink`：`{ slug, permalink, title }` の型。`permalink` は解決済みの canonical URL
+- `ArticleBacklink`：`{ slug, permalink, title }` の型。`permalink` は解決済みの正規 URL
 
 ## 関連資料
 

package/dist/index.d.ts

@@ -3,4 +3,4 @@ export { default as Backlinks } from "./components/backlinks.js";
 export type { ArticleBacklink } from "./src/backlinks.js";
 export { getBacklinks, getPublishedBacklinks } from "./src/backlinks.server.js";
 export type BacklinksOptions = Record<never, never>;
-export declare function backlinksPlugin(options?: BacklinksOptions): import("@riebeckite/core").RiebeckitePlugin<BacklinksOptions>;
+export declare function backlinks(options?: BacklinksOptions): import("@riebeckite/core").RiebeckitePlugin<BacklinksOptions>;

package/dist/index.js

@@ -33,17 +33,17 @@ import { jsx, jsxs } from "hono/jsx/jsx-runtime";
 var Backlinks = (async (props) => {
   const site = useSiteContext();
   const article = useArticleContext();
-  const backlinks = props.backlinks ?? (site && article?.entry ? await getBacklinks({ view: site.view, slug: article.entry.slug }) : void 0);
-  if (!backlinks || backlinks.length === 0) return html``;
+  const backlinks2 = props.backlinks ?? (site && article?.entry ? await getBacklinks({ view: site.view, slug: article.entry.slug }) : void 0);
+  if (!backlinks2 || backlinks2.length === 0) return html``;
   return /* @__PURE__ */ jsxs("footer", { class: "rr-backlinks", children: [
     /* @__PURE__ */ jsx("p", { class: "rr-backlinks__eyebrow", children: "Backlinks" }),
-    /* @__PURE__ */ jsx("ul", { class: "rr-backlinks__list", children: backlinks.map((backlink) => /* @__PURE__ */ jsx("li", { class: "rr-backlinks__item", children: /* @__PURE__ */ jsx("a", { class: "rr-backlinks__link", href: backlink.permalink, children: backlink.title }) }, backlink.slug)) })
+    /* @__PURE__ */ jsx("ul", { class: "rr-backlinks__list", children: backlinks2.map((backlink) => /* @__PURE__ */ jsx("li", { class: "rr-backlinks__item", children: /* @__PURE__ */ jsx("a", { class: "rr-backlinks__link", href: backlink.permalink, children: backlink.title }) }, backlink.slug)) })
   ] });
 });
 var backlinks_default = Backlinks;
 
 // index.ts
-function backlinksPlugin(options = {}) {
+function backlinks(options = {}) {
   return definePlugin({
     name: "backlinks",
     order: 500,
@@ -59,7 +59,7 @@ function backlinksPlugin(options = {}) {
 }
 export {
   backlinks_default as Backlinks,
-  backlinksPlugin,
+  backlinks,
   getBacklinks,
   getPublishedBacklinks
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-backlinks",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,13 +21,13 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "hono": "^4.12.25",
-    "@riebeckite/ui": "0.0.32",
-    "@riebeckite/core": "0.0.32"
+    "@riebeckite/core": "0.0.33",
+    "@riebeckite/ui": "0.0.33",
+    "hono": "^4.12.25"
   },
   "devDependencies": {
-    "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.32"
+    "@riebeckite/test": "0.0.33",
+    "tsx": "^4.22.4"
   },
   "publishConfig": {
     "access": "public"