@riebeckite/plugin-related-posts 0.0.31 → 0.0.33

package/README.md

@@ -97,7 +97,7 @@ import "@riebeckite/plugin-related-posts/style.css";
 ## Exports
 
 - `relatedPosts(options?)` — plugin factory
-- `relatedPostsPlugin` — alias of `relatedPosts`
+- `relatedPosts` — alias of `relatedPosts`
 - `resolveRelatedPostsOptions(options?)` — apply option defaults
 - `buildRelatedPosts({ manifest, entry, options, config? })` — rank related entries
 - `renderRelatedPosts(entries, options)` — render the navigation HTML

package/README_ja.md

@@ -2,17 +2,13 @@
 
 <!-- Generated from docs/docs/plugins/related-posts.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-ビルド時に「関連ノート」ナビゲーションのデータを生成するプラグインです。公開対象の
-各エントリについて、コンテンツマニフェスト上の他のエントリをスコア順に並べます。
-Site が `<RelatedPosts />` コンポーネントを記事の後などに配置します。クライアント側
-JavaScript は不要です。
+ビルド時に「関連ノート」ナビゲーションのデータを生成するプラグインです。公開対象の各エントリについて、コンテンツマニフェスト上の他のエントリをスコア順に並べます。サイトが `<RelatedPosts />` コンポーネントを記事の後などに配置します。クライアント側 JavaScript は不要です。
 
 [English](./README.md)
 
 ## 推奨配置
 
-`relatedPosts()` はマニフェストのコンテンツグラフを読み、現在のエントリと
-他の公開エントリを次のシグナルで採点します。
+`relatedPosts()` はマニフェストのコンテンツグラフを読み、現在のエントリと他の公開エントリを次のシグナルで採点します。
 
 | シグナル | 重み | 意味 |
 | -------- | ---- | ---- |
@@ -20,13 +16,9 @@ JavaScript は不要です。
 | タグの共有 | 共通タグ 1 件につき 2 | 現在のエントリと候補が同じタグを持つ |
 | 共引用 | 共通リンク先 1 件につき 1 | 両方のエントリが同じノートへリンクしている |
 
-候補はスコアの降順、同点ならタイトル、さらに同点ならスラッグの順に並べ、
-`limit` 件に絞ります。`minScore` 未満の候補は除外します。条件を満たす候補が
-1 件もない場合、そのエントリの HTML は変更しません。
+候補はスコアの降順、同点ならタイトル、さらに同点ならスラッグの順に並べ、`limit` 件に絞ります。`minScore` 未満の候補は除外します。条件を満たす候補が 1 件もない場合、そのエントリの HTML は変更しません。
 
-Site は `<RelatedPosts entries={...} options={...} />` コンポーネントを
-記事の後などに配置します。条件を満たす関連エントリがない場合、コンポーネントは
-何も描画しません。
+サイトは `<RelatedPosts entries={...} options={...} />` コンポーネントを記事の後などに配置します。条件を満たす関連エントリがない場合、コンポーネントは何も描画しません。
 
 ## クイックスタート
 
@@ -42,8 +34,7 @@ export default defineConfig({
 
 ## 高度なカスタマイズ
 
-Site のレイアウト内で任意の位置に配置できるサーバー描画の Hono JSX Component
-を公開しています。helper で entries を計算して解決済み options を渡してください。採点と公開境界のフィルタリングは維持されます。
+サイトのレイアウト内で任意の位置に配置できる、サーバー描画の Hono JSX コンポーネントを公開しています。ヘルパーで `entries` を計算し、解決済みの `options` を渡してください。採点と公開境界のフィルタリングは維持されます。
 
 ```tsx
 import { buildRelatedPosts, RelatedPosts, resolveRelatedPostsOptions } from "@riebeckite/plugin-related-posts";
@@ -54,7 +45,7 @@ const entries = buildRelatedPosts({ manifest, entry, options, config });
 <nav rb-related-posts><RelatedPosts entries={entries} options={options} /></nav>;
 ```
 
-1つの記事につき1回だけ描画してください。UI を外すにはコンポーネントを取り除きます。
+1 つの記事につき 1 回だけ描画してください。UI を外すにはコンポーネントを取り除きます。
 
 ## オプション
 
@@ -76,10 +67,9 @@ relatedPosts({
 });
 ```
 
-## 表示
+## 記事下に表示されるナビゲーション
 
-このサイトでは、条件に合う公開エントリがあれば記事下に実際のナビゲーションを
-表示します。
+このサイトでは、条件に合う公開エントリがあれば、記事の下に実際のナビゲーションを表示します。
 
 ## スタイル
 
@@ -92,11 +82,11 @@ import "@riebeckite/plugin-related-posts/style.css";
 ## エクスポート
 
 - `relatedPosts(options?)`：プラグインファクトリ
-- `relatedPostsPlugin`：`relatedPosts` のエイリアス
+- `relatedPosts`：`relatedPosts` のエイリアス
 - `resolveRelatedPostsOptions(options?)`：オプションの既定値を適用する
 - `buildRelatedPosts({ manifest, entry, options, config? })`：関連エントリを採点・整列する
 - `renderRelatedPosts(entries, options)`：ナビゲーション HTML を生成する
-- `RelatedPosts` と `@riebeckite/plugin-related-posts/components`：Hono JSX Component
+- `RelatedPosts` と `@riebeckite/plugin-related-posts/components`：Hono JSX コンポーネント
 - 型: `RelatedPostsOptions`, `ResolvedRelatedPostsOptions`, `RelatedPostsEntry`
 
 ## 制約

package/dist/index.d.ts

@@ -7,5 +7,3 @@ export { RELATED_POSTS_ATTRIBUTE, renderRelatedPosts, } from "./src/render.js";
 export type { RelatedPostsEntry, RelatedPostsOptions, ResolvedRelatedPostsOptions, } from "./src/types.js";
 export declare const RELATED_POSTS_PLUGIN_NAME = "related-posts";
 export declare function relatedPosts(options?: RelatedPostsOptions): import("@riebeckite/core").RiebeckitePlugin<RelatedPostsOptions>;
-/** Alias matching the `*Plugin` suffix used by other plugin factories. */
-export declare const relatedPostsPlugin: typeof relatedPosts;

package/dist/index.js

@@ -219,7 +219,6 @@ function relatedPosts(options = {}) {
     ]
   });
 }
-var relatedPostsPlugin = relatedPosts;
 function validateRelatedPostsOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -263,7 +262,6 @@ export {
   getRelatedPosts,
   isEligibleRelatedEntry,
   relatedPosts,
-  relatedPostsPlugin,
   renderRelatedPosts,
   resolveRelatedPostsOptions
 };

package/dist/src/options.d.ts

@@ -1,8 +1,4 @@
 import type { RelatedPostsOptions, ResolvedRelatedPostsOptions } from "./types.js";
-export declare const DEFAULT_RELATED_POSTS_LIMIT = 5;
-export declare const DEFAULT_RELATED_POSTS_MIN_SCORE = 1;
-export declare const DEFAULT_RELATED_POSTS_HEADING_TEXT = "Related";
-export declare const DEFAULT_RELATED_POSTS_CLASS_NAME = "rb-related-posts";
 /**
  * Applies defaults to `RelatedPostsOptions`. Pure and deterministic so the
  * plugin can resolve options once and reuse them for every manifest entry.

package/dist/src/related.d.ts

@@ -11,7 +11,7 @@ export declare const DIRECT_LINK_WEIGHT = 3;
 export declare const SHARED_TAG_WEIGHT = 2;
 /** Added once per note that both entries link to. */
 export declare const CO_CITATION_WEIGHT = 1;
-export type BuildRelatedPostsArgs = {
+type BuildRelatedPostsArgs = {
     manifest: ContentManifest;
     entry: ContentManifestEntry;
     options: ResolvedRelatedPostsOptions;
@@ -34,3 +34,4 @@ export declare const getRelatedPosts: PluginDataHelper<{
  * shadowed by a redirect. Hidden and redirect-only entries are skipped.
  */
 export declare function isEligibleRelatedEntry(entry: ContentManifestEntry, manifest: ContentManifest, _config?: ResolvedRiebeckiteConfig): boolean;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-related-posts",
-  "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/ui": "0.0.31",
-    "@riebeckite/core": "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"