@riebeckite/plugin-local-graph 0.0.20 → 0.0.22

package/README.md

@@ -1,11 +1,13 @@
 # @riebeckite/plugin-local-graph
 
+<!-- Generated from docs/docs/plugins/local-graph.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
 Local (nearby notes) graph rendering: a compact radial graph of a note's
 outgoing links and backlinks.
 
 [日本語](./README_ja.md)
 
-## Overview
+## Recommended placement
 
 `localGraph()` provides a `LocalGraph` component that renders the current note
 plus its direct links as an SVG radial graph. `getLocalGraph()` collects the
@@ -22,7 +24,11 @@ Relations are tagged per node:
 
 The component renders nothing when there is no published neighbor.
 
-## Usage
+`localGraphPlugin()` automatically contributes this component to
+`article.footer`. The Site decides where that semantic slot is rendered; the
+official Starter renders it after article content.
+
+## Quick Start
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
@@ -34,15 +40,19 @@ export default defineConfig({
 });
 ```
 
-`localGraphPlugin()` registers the plugin in the plugin list and bundles
-`style.css` into the app stylesheet.
+`localGraphPlugin()` registers the plugin and bundles `style.css` into the app
+stylesheet. Render `<ContentSlot slots={bodySlots} name="article.footer" />`
+once in the article layout to show automatic output.
+
+## Advanced customization
 
-### Render the component
+Set `render: false` to use the public data resolver and component in a
+Site-owned location without duplicating the automatic footer. This leaves graph
+generation and published-neighbor filtering intact.
 
 ```tsx
 import LocalGraph, { getLocalGraph } from "@riebeckite/plugin-local-graph";
-import { config } from "../config";
-import { content } from "../content";
+import { content } from "virtual:riebeckite/content";
 import { getArticleTitle } from "../lib/article-title";
 
 const manifest = await content.getManifest();
@@ -55,12 +65,22 @@ const graph = getLocalGraph({
 
 // ...in your route
 return (
-  <Article
-    footerContent={graph && <LocalGraph graph={graph} />}
-  />
+  <aside>{graph && <LocalGraph graph={graph} />}</aside>
 );
 ```
 
+```ts
+plugins: [localGraphPlugin({ render: false })];
+```
+
+Remove the component to remove manually placed UI.
+
+## Configuration
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `render` | `boolean` | `true` | Append the graph to `article.footer`. Set `false` for manual placement. |
+
 ## Graph layout
 
 Node positions come from `layoutRadialGraph()`: the center node sits at the
@@ -81,6 +101,6 @@ internal selection key `/explore?note=<slug>`.
 
 ## See also
 
-- [Plugin guide](../../../docs/docs/reference/plugin-api.md)
+- [Plugin guide](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.md)
 - [`@riebeckite/plugin-backlinks`](../backlinks/README.md)
 - [`@riebeckite/plugin-garden-explorer`](../garden-explorer/README.md)

package/README_ja.md

@@ -1,16 +1,20 @@
 # @riebeckite/plugin-local-graph
 
+<!-- Generated from docs/docs/plugins/local-graph.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
 現在のノートと、その前後につながるノートを小さな放射状グラフで表示するプラグインです。
 
 [English](./README.md)
 
-## できること
+## 推奨配置
 
 `getLocalGraph()` はマニフェストからリンク先と被リンク元を集め、公開済みノートだけを残します。各方向は最大 10 件です。`LocalGraph` はそのデータを SVG として描画し、周辺ノートがなければ何も表示しません。
 
+`localGraphPlugin()` は既定で `article.footer` slot に自動追加します。物理的な位置は Site が決め、公式 Starter は記事本文の後でこの slot を描画します。
+
 ノードには `current`、`outgoing`、`backlink`、`both` の関係が付きます。中央が現在のノート、周囲が直接つながるノートです。
 
-## 設定と配置
+## クイックスタート
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
@@ -19,6 +23,12 @@ import { localGraphPlugin } from "@riebeckite/plugin-local-graph";
 export default defineConfig({ plugins: [localGraphPlugin()] });
 ```
 
+記事レイアウトで `<ContentSlot slots={bodySlots} name="article.footer" />` を一度描画します。
+
+## 高度なカスタマイズ
+
+重複させずに Site 側で配置を決めるには、`render: false` を指定します。グラフの生成と公開済み近傍だけを残すフィルタリングは維持されます。
+
 ```tsx
 import LocalGraph, { getLocalGraph } from "@riebeckite/plugin-local-graph";
 
@@ -26,6 +36,16 @@ const graph = getLocalGraph({ manifest: await content.getManifest(), config, slu
 return <Article footerContent={graph && <LocalGraph graph={graph} />} />;
 ```
 
+```ts
+plugins: [localGraphPlugin({ render: false })];
+```
+
+## 設定
+
+| オプション | 型 | 既定値 | 説明 |
+| --- | --- | --- | --- |
+| `render` | `boolean` | `true` | `article.footer` への自動追加。手動配置では `false`。 |
+
 グラフのノード位置は `layoutRadialGraph()`、辺は `buildGraphEdges()` が計算します。各ノードのリンクは解決済みの `permalink` を使い、見出しは internal selection key `/explore?note=<slug>` で Explorer を開きます。
 
 ## 公開 API
@@ -37,7 +57,6 @@ return <Article footerContent={graph && <LocalGraph graph={graph} />} />;
 
 ## 関連資料
 
-- [プラグインシステム](../../../docs/docs/reference/plugin-api.ja.md)
+- [プラグインシステム](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.ja.md)
 - [`@riebeckite/plugin-backlinks`](../backlinks/README_ja.md)
 - [`@riebeckite/plugin-garden-explorer`](../garden-explorer/README_ja.md)
-

package/dist/index.d.ts

@@ -3,4 +3,7 @@ export { default as LocalGraph } from "./components/local-graph.js";
 export type { LocalGraphData, LocalGraphNode, LocalGraphNodeRelation, } from "./src/local-graph.js";
 export { getLocalGraph } from "./src/local-graph.server.js";
 export { buildGraphEdges, layoutRadialGraph };
-export declare function localGraphPlugin(): import("@riebeckite/core").RiebeckitePlugin<unknown>;
+export type LocalGraphOptions = {
+    render?: boolean;
+};
+export declare function localGraphPlugin(options?: LocalGraphOptions): import("@riebeckite/core").RiebeckitePlugin<LocalGraphOptions>;

package/dist/index.js

@@ -185,11 +185,14 @@ function getRelation(slug, currentSlug, outgoing, backlinks) {
 }
 
 // index.ts
-function localGraphPlugin() {
+function localGraphPlugin(options = {}) {
   return definePlugin({
     name: "local-graph",
     order: 400,
+    options,
+    validateOptions: validateLocalGraphOptions,
     onManifestCreated: ({ config, manifest }) => {
+      if (options.render === false) return;
       if (!config) return;
       for (const entry of manifest.discoverableEntries) {
         const graph = getLocalGraph({
@@ -215,6 +218,12 @@ function localGraphPlugin() {
     ]
   });
 }
+function validateLocalGraphOptions(options) {
+  if (!options || options.render === void 0 || typeof options.render === "boolean") {
+    return [];
+  }
+  return [{ path: "render", message: "Expected a boolean." }];
+}
 function resolveTitle(slug, title) {
   if (typeof title === "string" && title.trim()) return title;
   return slug.split("/").at(-1) ?? slug;

package/package.json

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