@riebeckite/plugin-backlinks 0.0.16 → 0.0.18

package/README.md

@@ -7,10 +7,10 @@ current note.
 
 ## Overview
 
-`backlinks()` provides a `Backlinks` component that renders a footer list of
-incoming links. `getPublishedBacklinks()` resolves the incoming links of a
-note from the content manifest, keeps only notes whose `frontmatter` passes
-`isPublished`, and returns them sorted in manifest order.
+`backlinksPlugin()` appends a footer list of incoming links to the
+`article.footer` body slot. `getPublishedBacklinks()` resolves the incoming
+links of a note from the content manifest, keeps only publicly discoverable
+notes, and returns them sorted in manifest order.
 
 Without incoming links (or when none of them are published), the component
 renders nothing.
@@ -27,10 +27,11 @@ export default defineConfig({
 });
 ```
 
-`backlinksPlugin()` registers the plugin in the plugin list and bundles
-`style.css` into the app stylesheet.
+`backlinksPlugin()` adds backlinks for every public entry with published
+incoming links and bundles `style.css` into the app stylesheet. Render the
+`article.footer` body slot in the article layout to display the list.
 
-### Render the component
+### Custom placement
 
 ```tsx
 import Backlinks, { getPublishedBacklinks } from "@riebeckite/plugin-backlinks";
@@ -46,7 +47,6 @@ const backlinks = getPublishedBacklinks({
   resolveTitle: getArticleTitle,
 });
 
-// ...in your route
 return (
   <Article
     footerContent={<Backlinks backlinks={backlinks} />}
@@ -56,7 +56,7 @@ return (
 
 ## Component
 
-`Backlinks({ backlinks })` renders a `<footer class="article-backlinks">` with
+`Backlinks({ backlinks })` renders a `<footer class="article-backlinks rr-backlinks">` with
 an eyebrow label and a list of links to each backlink's resolved `permalink`.
 
 ## Exports
@@ -69,6 +69,6 @@ an eyebrow label and a list of links to each backlink's resolved `permalink`.
 
 ## See also
 
-- [Plugin guide](../../../docs/en/docs/reference/plugin-api.md)
+- [Plugin guide](../../../docs/docs/reference/plugin-api.en.md)
 - [`@riebeckite/plugin-local-graph`](../local-graph/README.md)
 - [`@riebeckite/plugin-garden-explorer`](../garden-explorer/README.md)

package/README_ja.md

@@ -6,7 +6,7 @@
 
 ## できること
 
-`getPublishedBacklinks()` はコンテンツマニフェストから被リンクを集め、`isPublished` を通るノートだけをマニフェスト順で返します。`Backlinks` コンポーネントはその結果をフッターのリンク一覧として描画します。表示対象がなければ何も出力しません。
+`backlinksPlugin()` はコンテンツマニフェストから被リンクを集め、公開対象のノートだけをマニフェスト順で `article.footer` body slot に追加します。`Backlinks` コンポーネントはその結果をフッターのリンク一覧として描画します。表示対象がなければ何も出力しません。
 
 ## 設定と配置
 
@@ -20,7 +20,11 @@ export default defineConfig({
 });
 ```
 
-プラグイン登録後も、表示位置はアプリ側で決めます。記事ルートなどでマニフェストを取得し、現在の `slug` に対する被リンクを渡してください。
+プラグインは公開済みの被リンクがある記事へ自動的に出力を追加します。記事レイアウトで `article.footer` body slot を描画してください。
+
+### 独自の配置
+
+Plugin が追加する footer ではなく、アプリ側で表示位置を決める場合は、記事ルートなどでマニフェストを取得し、現在の `slug` に対する被リンクを渡してください。
 
 ```tsx
 import Backlinks, { getPublishedBacklinks } from "@riebeckite/plugin-backlinks";
@@ -40,7 +44,6 @@ return <Article footerContent={<Backlinks backlinks={items} />} />;
 
 ## 関連資料
 
-- [プラグインシステム](../../../docs/ja/docs/reference/plugin-api.md)
+- [プラグインシステム](../../../docs/docs/reference/plugin-api.md)
 - [`@riebeckite/plugin-local-graph`](../local-graph/README_ja.md)
 - [`@riebeckite/plugin-garden-explorer`](../garden-explorer/README_ja.md)
-

package/dist/index.js

@@ -1,5 +1,6 @@
 // index.ts
-import { definePlugin } from "@riebeckite/core";
+import { appendContentBodySlot, definePlugin } from "@riebeckite/core";
+import { renderToString } from "hono/jsx/dom/server";
 
 // components/backlinks.tsx
 import { jsx, jsxs } from "hono/jsx/jsx-runtime";
@@ -33,6 +34,24 @@ function getPublishedBacklinks(args) {
 function backlinksPlugin() {
   return definePlugin({
     name: "backlinks",
+    order: 500,
+    onManifestCreated: ({ config, manifest }) => {
+      if (!config) return;
+      for (const entry of manifest.discoverableEntries) {
+        const backlinks = getPublishedBacklinks({
+          manifest,
+          config,
+          slug: entry.slug,
+          resolveTitle
+        });
+        if (backlinks.length === 0) continue;
+        appendContentBodySlot(
+          entry,
+          "article.footer",
+          renderToString(Backlinks({ backlinks }))
+        );
+      }
+    },
     assets: [
       {
         pluginName: "backlinks",
@@ -42,6 +61,10 @@ function backlinksPlugin() {
     ]
   });
 }
+function resolveTitle(slug, title) {
+  if (typeof title === "string" && title.trim()) return title;
+  return slug.split("/").at(-1) ?? slug;
+}
 export {
   Backlinks,
   backlinksPlugin,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-backlinks",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -22,11 +22,11 @@
   },
   "dependencies": {
     "hono": "^4.12.25",
-    "@riebeckite/core": "0.0.16"
+    "@riebeckite/core": "0.0.18"
   },
   "devDependencies": {
     "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.16"
+    "@riebeckite/test": "0.0.18"
   },
   "publishConfig": {
     "access": "public"

package/style.css

@@ -1,6 +1,5 @@
 .article-backlinks {
-  margin-top: 4rem;
-  margin-bottom: 4rem;
+  margin-block-start: var(--rb-space-6, 3rem);
   padding-top: 1.5rem;
   border-top: 1px solid color-mix(in srgb, currentColor 16%, transparent);
 }