@riebeckite/plugin-local-graph 0.0.31 → 0.0.33

package/README.md

@@ -7,6 +7,10 @@ outgoing links and backlinks.
 
 [日本語](./README_ja.md)
 
+## Live example
+
+Open [Backlink](/docs/glossary/backlink) to see the local graph at the bottom of the article, centered on that page and its neighbors.
+
 ## Recommended placement
 
 `localGraph()` provides a `LocalGraph` component that renders the current note
@@ -22,15 +26,15 @@ neighbor.
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { localGraphPlugin } from "@riebeckite/plugin-local-graph";
+import { localGraph } from "@riebeckite/plugin-local-graph";
 
 export default defineConfig({
   // ...
-  plugins: [localGraphPlugin()],
+  plugins: [localGraph()],
 });
 ```
 
-`localGraphPlugin()` registers the plugin and bundles `style.css` into the app
+`localGraph()` registers the plugin and bundles `style.css` into the app
 stylesheet. The Site renders `<LocalGraph />` component itself, normally once
 after article content, to display the graph output.
 
@@ -61,7 +65,7 @@ Render the component once per article. Remove the element to remove the UI.
 
 ## Configuration
 
-There are no plugin options for `localGraphPlugin`. The `LocalGraph` component
+There are no plugin options for `localGraph`. The `LocalGraph` component
 accepts `graph` as a required prop.
 
 ## Graph layout
@@ -74,7 +78,7 @@ internal selection key `/explore?note=<slug>`.
 
 ## Exports
 
-- `localGraphPlugin()` — plugin factory
+- `localGraph()` — plugin factory
 - `LocalGraph` — SVG graph component (default export of `components/local-graph.tsx`)
 - `getLocalGraph({ manifest, config, slug, resolveTitle })` — builds nearby-note
   data for a slug (`null` when the note is absent or unpublished)

package/README_ja.md

@@ -2,32 +2,36 @@
 
 <!-- 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)
 
+## 実行例
+
+[Backlink](/ja/docs/glossary/backlink) を開くと、そのページと隣接ページを中心としたローカルグラフが記事の末尾に表示されます。
+
 ## 推奨配置
 
-`getLocalGraph()` はマニフェストからリンク先と被リンク元を集め、公開済みノートだけを残します。各方向は最大 10 件です。`LocalGraph` はそのデータを SVG として描画し、周辺ノートがなければ何も表示しません。Site は `<LocalGraph />` コンポーネントを記事の後などに配置します。
+`getLocalGraph()` はマニフェストからリンク先と被リンク元を集め、公開済みノートだけを残します。リンク先と被リンク元はそれぞれ最大 10 件です。`LocalGraph` はそのデータを SVG として描画し、周辺ノートがなければ何も表示しません。Site は `<LocalGraph />` コンポーネントを記事の後などに配置します。
 
 ## クイックスタート
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { localGraphPlugin } from "@riebeckite/plugin-local-graph";
+import { localGraph } from "@riebeckite/plugin-local-graph";
 
-export default defineConfig({ plugins: [localGraphPlugin()] });
+export default defineConfig({ plugins: [localGraph()] });
 ```
 
 記事レイアウトで `<LocalGraph />` コンポーネントを一度描画します。
 
 ## 設定
 
-`localGraphPlugin()` にはプラグイン用のオプションがありません。`LocalGraph` コンポーネントは `graph` 必須プロップを受け取ります。
+`localGraph()` にはプラグイン用のオプションがありません。`LocalGraph` コンポーネントは必須プロップ `graph` を受け取ります。
 
 ## 高度なカスタマイズ
 
-サイト側で配置を決めるには、`getLocalGraph` を使ってデータを取得し、`<LocalGraph graph={...} />` コンポーネントを一度だけ描画してください。グラフの生成と公開済み近傍だけを残すフィルタリングは維持されます。
+サイト側で配置を決めるには、`getLocalGraph` を使ってデータを取得し、`<LocalGraph graph={...} />` コンポーネントを一度だけ描画してください。グラフの生成と、公開済みの近傍だけを残す絞り込みは維持されます。
 
 ```tsx
 import LocalGraph, { getLocalGraph } from "@riebeckite/plugin-local-graph";
@@ -35,11 +39,11 @@ const graph = getLocalGraph({ manifest: await content.getManifest(), config, slu
 return <aside>{graph ? <LocalGraph graph={graph} /> : null}</aside>;
 ```
 
-グラフのノード位置は `layoutRadialGraph()`、辺は `buildGraphEdges()` が計算します。各ノードのリンクは解決済みの `permalink` を使い、見出しは internal selection key `/explore?note=<slug>` で Explorer を開きます。
+グラフのノード位置は `layoutRadialGraph()`、辺は `buildGraphEdges()` が計算します。各ノードのリンクは解決済みの `permalink` を使い、ヘッダーは内部セレクションキー `/explore?note=<slug>` で Explorer を開きます。
 
 ## 公開 API
 
-- `localGraphPlugin()`、`LocalGraph`
+- `localGraph()`、`LocalGraph`
 - `getLocalGraph({ manifest, config, slug, resolveTitle })`
 - `buildGraphEdges(nodes, visibleSlugs?)`、`layoutRadialGraph(nodes, options)`
 - `LocalGraphData`、`LocalGraphNode`

package/dist/components/local-graph.js

@@ -1,5 +1,5 @@
 // components/local-graph.tsx
-import { buildGraphEdges, layoutRadialGraph } from "@riebeckite/core";
+import { buildGraphEdges, layoutRadialGraph } from "@riebeckite/core/client";
 import { useArticleContext, useSiteContext } from "@riebeckite/ui";
 import { html } from "hono/html";
 

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { buildGraphEdges, layoutRadialGraph } from "@riebeckite/core";
+import { buildGraphEdges, layoutRadialGraph } from "@riebeckite/core/client";
 export type { LocalGraphProps } from "./components/local-graph.js";
 export { default as LocalGraph } from "./components/local-graph.js";
 export type { LocalGraphData, LocalGraphNode, LocalGraphNodeRelation, } from "./src/local-graph.js";
 export { buildLocalGraph, getLocalGraph, } from "./src/local-graph.server.js";
 export { buildGraphEdges, layoutRadialGraph };
 export type LocalGraphOptions = Record<never, never>;
-export declare function localGraphPlugin(options?: LocalGraphOptions): import("@riebeckite/core").RiebeckitePlugin<LocalGraphOptions>;
+export declare function localGraph(options?: LocalGraphOptions): import("@riebeckite/core").RiebeckitePlugin<LocalGraphOptions>;

package/dist/index.js

@@ -1,12 +1,9 @@
 // index.ts
-import {
-  buildGraphEdges as buildGraphEdges2,
-  definePlugin,
-  layoutRadialGraph as layoutRadialGraph2
-} from "@riebeckite/core";
+import { definePlugin } from "@riebeckite/core";
+import { buildGraphEdges as buildGraphEdges2, layoutRadialGraph as layoutRadialGraph2 } from "@riebeckite/core/client";
 
 // components/local-graph.tsx
-import { buildGraphEdges, layoutRadialGraph } from "@riebeckite/core";
+import { buildGraphEdges, layoutRadialGraph } from "@riebeckite/core/client";
 import { useArticleContext, useSiteContext } from "@riebeckite/ui";
 import { html } from "hono/html";
 
@@ -206,7 +203,7 @@ var LocalGraph = (async (props) => {
 var local_graph_default = LocalGraph;
 
 // index.ts
-function localGraphPlugin(options = {}) {
+function localGraph(options = {}) {
   return definePlugin({
     name: "local-graph",
     order: 400,
@@ -226,5 +223,5 @@ export {
   buildLocalGraph,
   getLocalGraph,
   layoutRadialGraph2 as layoutRadialGraph,
-  localGraphPlugin
+  localGraph
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-local-graph",
-  "version": "0.0.31",
+  "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/core": "0.0.31",
-    "@riebeckite/ui": "0.0.31"
+    "@riebeckite/core": "0.0.33",
+    "@riebeckite/ui": "0.0.33",
+    "hono": "^4.12.25"
   },
   "devDependencies": {
-    "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.31"
+    "@riebeckite/test": "0.0.33",
+    "tsx": "^4.22.4"
   },
   "publishConfig": {
     "access": "public"