@riebeckite/plugin-related-posts 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,93 @@
+# @riebeckite/plugin-related-posts
+
+Build-time "related notes" navigation. For every published entry, the plugin
+ranks the other entries in the content manifest and appends a related-posts
+section to the rendered HTML. No client-side JavaScript is required.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`relatedPosts()` reads the manifest's content graph and scores every other
+published entry against the current one:
+
+| Signal | Weight | Meaning |
+| ------ | ------ | ------- |
+| Direct link | 3 | The entry links to the candidate, or the candidate links to the entry |
+| Shared tag | 2 per common tag | The entry and the candidate share a tag |
+| Co-citation | 1 per common target | Both entries link to the same note |
+
+Candidates are sorted by score (descending), then by title, then by slug, and
+clamped to `limit`. Entries that score below `minScore` are dropped. When no
+candidate qualifies, the entry's HTML is left untouched.
+
+The plugin updates both `entry.html` and the cached `PostContent.html` that the
+content route renders, so the section appears on generated pages and in feeds.
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { relatedPosts } from "@riebeckite/plugin-related-posts";
+
+export default defineConfig({
+  // ...
+  plugins: [relatedPosts()],
+});
+```
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `limit` | `number` | `5` | Maximum number of related entries |
+| `minScore` | `number` | `1` | Minimum score required to be listed |
+| `heading` | `boolean` | `true` | Render the `<h2>` heading |
+| `headingText` | `string` | `"Related"` | Heading text |
+| `className` | `string` | `"rb-related-posts"` | Root CSS class |
+| `useTags` | `boolean` | `true` | Include the shared-tag signal |
+| `useBacklinks` | `boolean` | `true` | Include the direct-link signal |
+
+```ts
+relatedPosts({
+  limit: 8,
+  minScore: 2,
+  headingText: "Related notes",
+});
+```
+
+## Output
+
+```html
+<nav class="rb-related-posts" data-related-posts>
+  <h2 class="rb-related-posts__heading">Related</h2>
+  <ul>
+    <li class="rb-related-posts__item">
+      <a class="rb-related-posts__link" href="/notes/example" data-related-score="5">Example Note</a>
+    </li>
+  </ul>
+</nav>
+```
+
+## Style
+
+The package ships `style.css`. Register it like any other plugin stylesheet:
+
+```ts
+import "@riebeckite/plugin-related-posts/style.css";
+```
+
+## Exports
+
+- `relatedPosts(options?)` — plugin factory
+- `relatedPostsPlugin` — alias of `relatedPosts`
+- `resolveRelatedPostsOptions(options?)` — apply option defaults
+- `buildRelatedPosts({ manifest, entry, options, config? })` — rank related entries
+- `renderRelatedPosts(entries, options)` — render the navigation HTML
+- Types: `RelatedPostsOptions`, `ResolvedRelatedPostsOptions`, `RelatedPostsEntry`
+
+## Limitations
+
+- Ranking is fixed at build time. A full rebuild always recomputes correctly.
+- Only tags, direct links, and co-citations are considered. Reading time,
+  recency, and folders are intentionally ignored to keep ranking deterministic.

package/README_ja.md

@@ -0,0 +1,95 @@
+# @riebeckite/plugin-related-posts
+
+ビルド時に「関連ノート」ナビゲーションを生成するプラグインです。公開対象の
+各エントリについて、コンテンツマニフェスト上の他のエントリをスコア順に並べ、
+関連ノートのセクションを HTML に追記します。クライアント側 JavaScript は
+不要です。
+
+[English](./README.md)
+
+## 仕組み
+
+`relatedPosts()` はマニフェストのコンテンツグラフを読み、現在のエントリと
+他の公開エントリを次のシグナルで採点します。
+
+| シグナル | 重み | 意味 |
+| -------- | ---- | ---- |
+| 直接リンク | 3 | 現在のエントリが候補へ、または候補が現在のエントリへリンクしている |
+| タグの共有 | 共通タグ1件につき2 | 現在のエントリと候補が同じタグを持つ |
+| 共引用 | 共通リンク先1件につき1 | 両方のエントリが同じノートへリンクしている |
+
+候補はスコアの降順、同点ならタイトル、さらに同点ならスラッグの順に並べ、
+`limit` 件に絞ります。`minScore` 未満の候補は除外します。条件を満たす候補が
+1件もない場合、そのエントリの HTML は変更しません。
+
+`entry.html` と、コンテンツルートが描画するキャッシュ済みの
+`PostContent.html` の両方を更新するため、生成ページとフィードの両方に
+セクションが反映されます。
+
+## 使い方
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { relatedPosts } from "@riebeckite/plugin-related-posts";
+
+export default defineConfig({
+  // ...
+  plugins: [relatedPosts()],
+});
+```
+
+## オプション
+
+| オプション | 型 | 既定値 | 説明 |
+| ---------- | -- | ------ | ---- |
+| `limit` | `number` | `5` | 表示する関連エントリの最大件数 |
+| `minScore` | `number` | `1` | 表示に必要な最小スコア |
+| `heading` | `boolean` | `true` | `<h2>` 見出しを出力する |
+| `headingText` | `string` | `"Related"` | 見出しの文言 |
+| `className` | `string` | `"rb-related-posts"` | ルート要素の CSS クラス |
+| `useTags` | `boolean` | `true` | タグ共有のシグナルを使う |
+| `useBacklinks` | `boolean` | `true` | 直接リンクのシグナルを使う |
+
+```ts
+relatedPosts({
+  limit: 8,
+  minScore: 2,
+  headingText: "関連ノート",
+});
+```
+
+## 出力
+
+```html
+<nav class="rb-related-posts" data-related-posts>
+  <h2 class="rb-related-posts__heading">Related</h2>
+  <ul>
+    <li class="rb-related-posts__item">
+      <a class="rb-related-posts__link" href="/notes/example" data-related-score="5">Example Note</a>
+    </li>
+  </ul>
+</nav>
+```
+
+## スタイル
+
+パッケージに `style.css` が含まれます。他のプラグインと同じように読み込みます。
+
+```ts
+import "@riebeckite/plugin-related-posts/style.css";
+```
+
+## エクスポート
+
+- `relatedPosts(options?)` — プラグインファクトリ
+- `relatedPostsPlugin` — `relatedPosts` のエイリアス
+- `resolveRelatedPostsOptions(options?)` — オプションの既定値を適用する
+- `buildRelatedPosts({ manifest, entry, options, config? })` — 関連エントリを採点・整列する
+- `renderRelatedPosts(entries, options)` — ナビゲーション HTML を生成する
+- 型: `RelatedPostsOptions`, `ResolvedRelatedPostsOptions`, `RelatedPostsEntry`
+
+## 制約
+
+- 並び順はビルド時に確定します。再ビルドすれば常に正しく再計算されます。
+- 判定材料はタグ・直接リンク・共引用のみです。読了時間や新しさ、フォルダは
+  順位を決定的に保つため意図的に使いません。

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import type { RelatedPostsOptions } from "./src/types.js";
+export { resolveRelatedPostsOptions } from "./src/options.js";
+export { buildRelatedPosts, CO_CITATION_WEIGHT, DIRECT_LINK_WEIGHT, isEligibleRelatedEntry, SHARED_TAG_WEIGHT, } from "./src/related.js";
+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";
+/**
+ * Build-time "related notes" navigation.
+ *
+ * For every published entry it ranks the other entries in the manifest, then
+ * appends a `<nav>` section to both `entry.html` and the cached
+ * `PostContent.html` that the content route renders. No client runtime is
+ * required.
+ */
+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

@@ -0,0 +1,197 @@
+// index.ts
+import {
+  createStyleAsset,
+  definePlugin
+} from "@riebeckite/core";
+
+// src/options.ts
+var DEFAULT_RELATED_POSTS_LIMIT = 5;
+var DEFAULT_RELATED_POSTS_MIN_SCORE = 1;
+var DEFAULT_RELATED_POSTS_HEADING_TEXT = "Related";
+var DEFAULT_RELATED_POSTS_CLASS_NAME = "rb-related-posts";
+function resolveRelatedPostsOptions(options = {}) {
+  return {
+    limit: options.limit ?? DEFAULT_RELATED_POSTS_LIMIT,
+    minScore: options.minScore ?? DEFAULT_RELATED_POSTS_MIN_SCORE,
+    heading: options.heading ?? true,
+    headingText: options.headingText ?? DEFAULT_RELATED_POSTS_HEADING_TEXT,
+    className: normalizeClassName(options.className),
+    useTags: options.useTags ?? true,
+    useBacklinks: options.useBacklinks ?? true
+  };
+}
+function normalizeClassName(className) {
+  if (typeof className !== "string") return DEFAULT_RELATED_POSTS_CLASS_NAME;
+  const trimmed = className.trim();
+  return trimmed === "" ? DEFAULT_RELATED_POSTS_CLASS_NAME : trimmed;
+}
+
+// src/related.ts
+import {
+  isPublished
+} from "@riebeckite/core";
+var DIRECT_LINK_WEIGHT = 3;
+var SHARED_TAG_WEIGHT = 2;
+var CO_CITATION_WEIGHT = 1;
+function buildRelatedPosts(args) {
+  const { manifest, entry, options } = args;
+  const scores = /* @__PURE__ */ new Map();
+  const outgoingTargets = collectNoteTargets(
+    manifest.outgoingLinks.get(entry.slug) ?? [],
+    entry.slug
+  );
+  if (options.useTags) {
+    for (const tag of entry.tags) {
+      for (const candidate of manifest.byTag.get(tag) ?? []) {
+        if (candidate.slug === entry.slug) continue;
+        addScore(scores, candidate.slug, SHARED_TAG_WEIGHT);
+      }
+    }
+  }
+  if (options.useBacklinks) {
+    const incoming = manifest.incomingLinks.get(entry.slug) ?? [];
+    for (const slug of /* @__PURE__ */ new Set([...outgoingTargets, ...incoming])) {
+      if (slug === entry.slug) continue;
+      addScore(scores, slug, DIRECT_LINK_WEIGHT);
+    }
+  }
+  for (const target of outgoingTargets) {
+    for (const source of manifest.incomingLinks.get(target) ?? []) {
+      if (source === entry.slug) continue;
+      addScore(scores, source, CO_CITATION_WEIGHT);
+    }
+  }
+  const candidates = [];
+  for (const [slug, score] of scores) {
+    if (score < options.minScore) continue;
+    const candidate = manifest.bySlug.get(slug);
+    if (!candidate) continue;
+    if (!isEligibleRelatedEntry(candidate, manifest, args.config)) continue;
+    candidates.push({
+      slug: candidate.slug,
+      permalink: candidate.permalink,
+      title: candidate.title,
+      score
+    });
+  }
+  candidates.sort(compareRelatedEntries);
+  return candidates.slice(0, options.limit);
+}
+function isEligibleRelatedEntry(entry, manifest, config) {
+  if (manifest.redirects.has(entry.permalink)) return false;
+  if (config) return isPublished(config, entry.frontmatter);
+  return entry.frontmatter.private !== true && entry.frontmatter.draft !== true && entry.frontmatter.publish !== false;
+}
+function compareRelatedEntries(a, b) {
+  if (b.score !== a.score) return b.score - a.score;
+  const byTitle = a.title.localeCompare(b.title);
+  if (byTitle !== 0) return byTitle;
+  return a.slug.localeCompare(b.slug);
+}
+function collectNoteTargets(links, sourceSlug) {
+  const targets = /* @__PURE__ */ new Set();
+  for (const link of links) {
+    if (link.kind !== "note" || link.slug === null) continue;
+    if (link.slug === sourceSlug) continue;
+    targets.add(link.slug);
+  }
+  return [...targets];
+}
+function addScore(scores, slug, weight) {
+  scores.set(slug, (scores.get(slug) ?? 0) + weight);
+}
+
+// src/render.ts
+import { escapeHtml, escapeHtmlAttribute } from "@riebeckite/core";
+var RELATED_POSTS_ATTRIBUTE = "data-related-posts";
+function renderRelatedPosts(entries, options) {
+  if (entries.length === 0) return "";
+  const className = escapeHtmlAttribute(options.className);
+  const heading = options.heading ? `<h2 class="${className}__heading">${escapeHtml(options.headingText)}</h2>` : "";
+  const items = entries.map(
+    (entry) => `<li class="${className}__item"><a class="${className}__link" href="${escapeHtmlAttribute(
+      entry.permalink
+    )}" data-related-score="${entry.score}">${escapeHtml(entry.title)}</a></li>`
+  ).join("");
+  return `<nav class="${className}" ${RELATED_POSTS_ATTRIBUTE}>${heading}<ul>${items}</ul></nav>`;
+}
+
+// index.ts
+var RELATED_POSTS_PLUGIN_NAME = "related-posts";
+function relatedPosts(options = {}) {
+  const resolved = resolveRelatedPostsOptions(options);
+  const processed = /* @__PURE__ */ new Map();
+  return definePlugin({
+    name: RELATED_POSTS_PLUGIN_NAME,
+    options,
+    validateOptions: validateRelatedPostsOptions,
+    onPostProcessed: (context) => {
+      processed.set(context.slug, context.content);
+    },
+    onManifestCreated: (context) => {
+      const { manifest } = context;
+      for (const entry of manifest.entries) {
+        if (entry.html.includes(RELATED_POSTS_ATTRIBUTE)) continue;
+        if (!isEligibleRelatedEntry(entry, manifest, context.config)) continue;
+        const related = buildRelatedPosts({
+          manifest,
+          entry,
+          options: resolved,
+          config: context.config
+        });
+        if (related.length === 0) continue;
+        entry.html = `${entry.html}${renderRelatedPosts(related, resolved)}`;
+        const content = processed.get(entry.slug);
+        if (content) content.html = entry.html;
+      }
+      processed.clear();
+    },
+    assets: [createStyleAsset(RELATED_POSTS_PLUGIN_NAME)]
+  });
+}
+var relatedPostsPlugin = relatedPosts;
+function validateRelatedPostsOptions(options) {
+  if (!options) return [];
+  const issues = [];
+  if (options.limit !== void 0 && (!Number.isInteger(options.limit) || options.limit < 0)) {
+    issues.push({ path: "limit", message: "Expected a non-negative integer." });
+  }
+  if (options.minScore !== void 0 && (!Number.isFinite(options.minScore) || options.minScore < 0)) {
+    issues.push({
+      path: "minScore",
+      message: "Expected a non-negative finite number."
+    });
+  }
+  if (options.heading !== void 0 && typeof options.heading !== "boolean") {
+    issues.push({ path: "heading", message: "Expected a boolean." });
+  }
+  if (options.headingText !== void 0 && (typeof options.headingText !== "string" || options.headingText.trim() === "")) {
+    issues.push({
+      path: "headingText",
+      message: "Expected a non-empty string."
+    });
+  }
+  if (options.className !== void 0 && (typeof options.className !== "string" || options.className.trim() === "")) {
+    issues.push({ path: "className", message: "Expected a non-empty string." });
+  }
+  if (options.useTags !== void 0 && typeof options.useTags !== "boolean") {
+    issues.push({ path: "useTags", message: "Expected a boolean." });
+  }
+  if (options.useBacklinks !== void 0 && typeof options.useBacklinks !== "boolean") {
+    issues.push({ path: "useBacklinks", message: "Expected a boolean." });
+  }
+  return issues;
+}
+export {
+  CO_CITATION_WEIGHT,
+  DIRECT_LINK_WEIGHT,
+  RELATED_POSTS_ATTRIBUTE,
+  RELATED_POSTS_PLUGIN_NAME,
+  SHARED_TAG_WEIGHT,
+  buildRelatedPosts,
+  isEligibleRelatedEntry,
+  relatedPosts,
+  relatedPostsPlugin,
+  renderRelatedPosts,
+  resolveRelatedPostsOptions
+};

package/dist/src/options.d.ts

@@ -0,0 +1,10 @@
+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.
+ */
+export declare function resolveRelatedPostsOptions(options?: RelatedPostsOptions): ResolvedRelatedPostsOptions;

package/dist/src/related.d.ts

@@ -0,0 +1,31 @@
+import { type ContentManifest, type ContentManifestEntry, type ResolvedRiebeckiteConfig } from "@riebeckite/core";
+import type { RelatedPostsEntry, ResolvedRelatedPostsOptions } from "./types.js";
+/**
+ * Weights are deterministic constants: the same manifest always produces the
+ * same ranking. A direct link is the strongest signal, a shared tag is next,
+ * and a co-citation (both entries linking to the same note) is the weakest.
+ */
+/** Added once for each entry reachable through a direct link. */
+export declare const DIRECT_LINK_WEIGHT = 3;
+/** Added once per tag shared with the source entry. */
+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 = {
+    manifest: ContentManifest;
+    entry: ContentManifestEntry;
+    options: ResolvedRelatedPostsOptions;
+    config?: ResolvedRiebeckiteConfig;
+};
+/**
+ * Ranks the published entries related to `entry` using the manifest's content
+ * graph. Pure build-time computation: it only reads `byTag`, `outgoingLinks`,
+ * `incomingLinks`, `redirects`, and `bySlug`.
+ */
+export declare function buildRelatedPosts(args: BuildRelatedPostsArgs): RelatedPostsEntry[];
+/**
+ * An entry may receive a related-posts section (and be offered as a related
+ * candidate) only when it is published and its canonical permalink is not
+ * shadowed by a redirect. Unpublished and redirect-only entries are skipped.
+ */
+export declare function isEligibleRelatedEntry(entry: ContentManifestEntry, manifest: ContentManifest, config?: ResolvedRiebeckiteConfig): boolean;

package/dist/src/render.d.ts

@@ -0,0 +1,8 @@
+import type { RelatedPostsEntry, ResolvedRelatedPostsOptions } from "./types.js";
+/** Boolean attribute that marks the generated navigation for tests and styling. */
+export declare const RELATED_POSTS_ATTRIBUTE = "data-related-posts";
+/**
+ * Renders the related-posts navigation. Returns an empty string when there is
+ * nothing to show, so callers can leave an entry's HTML untouched.
+ */
+export declare function renderRelatedPosts(entries: readonly RelatedPostsEntry[], options: ResolvedRelatedPostsOptions): string;

package/dist/src/types.d.ts

@@ -0,0 +1,35 @@
+/** Options accepted by `relatedPosts()`. */
+export type RelatedPostsOptions = {
+    /** Maximum number of related entries to render. Defaults to `5`. */
+    limit?: number;
+    /** Minimum score a candidate must reach to be listed. Defaults to `1`. */
+    minScore?: number;
+    /** Render the `<h2>` heading. Defaults to `true`. */
+    heading?: boolean;
+    /** Heading text. Defaults to `"Related"`. */
+    headingText?: string;
+    /** Root CSS class of the generated `<nav>`. Defaults to `"rb-related-posts"`. */
+    className?: string;
+    /** Use shared tags as a relatedness signal. Defaults to `true`. */
+    useTags?: boolean;
+    /** Use direct links (outgoing and incoming) as a relatedness signal. Defaults to `true`. */
+    useBacklinks?: boolean;
+};
+/** `RelatedPostsOptions` with every default applied. */
+export type ResolvedRelatedPostsOptions = {
+    limit: number;
+    minScore: number;
+    heading: boolean;
+    headingText: string;
+    className: string;
+    useTags: boolean;
+    useBacklinks: boolean;
+};
+/** A single ranked related entry, ready to render. */
+export type RelatedPostsEntry = {
+    slug: string;
+    permalink: string;
+    title: string;
+    /** Deterministic non-negative score used for ranking and `data-related-score`. */
+    score: number;
+};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@riebeckite/plugin-related-posts",
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "source": "./index.ts",
+      "default": "./dist/index.js"
+    },
+    "./style.css": "./style.css"
+  },
+  "dependencies": {
+    "@riebeckite/core": "0.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist",
+    "style.css"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/related-posts"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Build-time related-post navigation for Riebeckite.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "related-posts",
+    "navigation"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": [
+    "./style.css"
+  ],
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs"
+  }
+}

package/style.css

@@ -0,0 +1,51 @@
+.rb-related-posts {
+  --rb-related-posts-ink: var(--rb-color-ink, #000000);
+  --rb-related-posts-muted: var(--rb-color-muted, #69645c);
+  --rb-related-posts-rule: color-mix(
+    in srgb,
+    var(--rb-related-posts-ink) 16%,
+    transparent
+  );
+
+  margin-top: 3rem;
+  padding-top: 1.5rem;
+  border-top: 1px solid var(--rb-related-posts-rule);
+  color: var(--rb-related-posts-ink);
+}
+
+.rb-related-posts__heading {
+  margin: 0 0 1rem;
+  font-size: 1.125rem;
+  font-weight: 700;
+  letter-spacing: 0.02em;
+}
+
+.rb-related-posts ul {
+  display: grid;
+  gap: 0.5rem;
+  margin: 0;
+  padding: 0;
+  list-style: none;
+}
+
+.rb-related-posts__item {
+  margin: 0;
+  padding: 0;
+}
+
+.rb-related-posts__link {
+  color: inherit;
+  text-decoration: underline;
+  text-decoration-color: var(--rb-related-posts-rule);
+  text-underline-offset: 0.2em;
+}
+
+.rb-related-posts__link:hover,
+.rb-related-posts__link:focus-visible {
+  text-decoration-color: var(--rb-related-posts-muted);
+}
+
+html[data-theme="dark"] .rb-related-posts,
+html.dark .rb-related-posts {
+  --rb-related-posts-ink: var(--rb-color-paper, #ffffff);
+}