@riebeckite/plugin-breadcrumbs 0.0.5

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,112 @@
+# @riebeckite/plugin-breadcrumbs
+
+Build-time breadcrumb navigation derived from the note's slug hierarchy. For
+every published entry the plugin inserts a `<nav>` at the top of the rendered
+HTML and enriches the page with a hierarchical BreadcrumbList JSON-LD schema.
+No client-side JavaScript is required.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`breadcrumbs()` reads the entry's slug, splits it into segments, and produces a
+trail that always starts at the site home:
+
+- `Home / folder / sub-folder / Note` for `folder/sub-folder/note`
+- `Home / Note` for a note at the site root
+
+Intermediate segments are resolved against the manifest first: when the folder
+has an index note of its own (a note with the folder slug), that note's title
+is used for the crumb, otherwise the segment is title-cased. The final crumb is
+the note itself and links to its permalink.
+
+The plugin updates both `entry.html` and the cached `PostContent.html` that the
+content route renders, so the nav appears on generated pages and in feeds.
+
+## JSON-LD
+
+`breadcrumbs()` contributes the hierarchical BreadcrumbList as an
+`entry.headTags` `<script type="application/ld+json">` so the Site shell can
+render it in the document `<head>` (the reference Riebeckite app renders
+`entry.headTags` in `_renderer.tsx`). Item URLs are made absolute against the
+configured site `baseUrl`.
+
+When the `seo` plugin is also enabled it emits a two-level BreadcrumbList
+(`Home / Note`) inside its own article JSON-LD. The two blocks coexist; to
+avoid duplicate BreadcrumbList entities a Site can drop the seo plugin's
+placeholder for article pages (shown in the reference app's content route) or
+disable `jsonLd` on this plugin (`jsonLd: false`).
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { breadcrumbs } from "@riebeckite/plugin-breadcrumbs";
+
+export default defineConfig({
+  // ...
+  plugins: [breadcrumbs()],
+});
+```
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `homeLabel` | `string` | site title | Home crumb label |
+| `className` | `string` | `"rb-breadcrumbs"` | Root CSS class |
+| `ariaLabel` | `string` | `"Breadcrumbs"` | Accessible nav name |
+| `separator` | `string` | `"/"` | Text between crumbs |
+| `jsonLd` | `boolean` | `true` | Emit/replace the BreadcrumbList script |
+
+```ts
+breadcrumbs({
+  homeLabel: "Blog",
+  separator: "›",
+});
+```
+
+## Output
+
+```html
+<nav class="rb-breadcrumbs" data-breadcrumbs aria-label="Breadcrumbs">
+  <ol>
+    <li class="rb-breadcrumbs__item">
+      <a class="rb-breadcrumbs__link" href="/">Blog</a>
+      <span class="rb-breadcrumbs__separator" aria-hidden="true">/</span>
+    </li>
+    <li class="rb-breadcrumbs__item">
+      <a class="rb-breadcrumbs__link" href="/folder">Folder</a>
+      <span class="rb-breadcrumbs__separator" aria-hidden="true">/</span>
+    </li>
+    <li class="rb-breadcrumbs__item">
+      <span class="rb-breadcrumbs__current" aria-current="page">Note</span>
+    </li>
+  </ol>
+</nav>
+```
+
+## Style
+
+The package ships `style.css`. Register it like any other plugin stylesheet:
+
+```ts
+import "@riebeckite/plugin-breadcrumbs/style.css";
+```
+
+## Exports
+
+- `breadcrumbs(options?)` — plugin factory
+- `breadcrumbsPlugin` — alias of `breadcrumbs`
+- `resolveBreadcrumbsOptions(options?)` — apply option defaults
+- `buildBreadcrumbItems({ manifest, entry, config, homeLabel })` — build the trail
+- `renderBreadcrumbNav(items, options)` — render the navigation HTML
+- `buildBreadcrumbJsonLd(config, items)` — build the JSON-LD object
+- `injectBreadcrumbNav(html, nav)` / `injectBreadcrumbJsonLd(html, schema)` — HTML injection helpers
+- Types: `BreadcrumbsOptions`, `ResolvedBreadcrumbsOptions`, `BreadcrumbItem`
+
+## Limitations
+
+- The trail is fixed at build time. A full rebuild always recomputes correctly.
+- Only the slug hierarchy is considered; folder ordering from frontmatter or
+  series plugins is intentionally ignored.

package/README_ja.md

@@ -0,0 +1,113 @@
+# @riebeckite/plugin-breadcrumbs
+
+ノートのスラッグ階層からパンくずナビゲーションをビルド時に生成する
+プラグインです。公開対象の各エントリについて、記事上部に `<nav>` を挿入し、
+階層構造を反映した BreadcrumbList の JSON-LD も出力します。クライアント側
+JavaScript は不要です。
+
+[English](./README.md)
+
+## 仕組み
+
+`breadcrumbs()` はエントリのスラッグを「/」で区切り、必ずサイトのホームから
+始まるパンくず列を作ります。
+
+- `folder/sub-folder/note` の場合: `ホーム / folder / sub-folder / note`
+- サイト直下のノートの場合: `ホーム / note`
+
+途中のフォルダはマニフェストと突き合わせて解決します。フォルダ自身に
+インデックスノート（フォルダと同名のスラッグを持つノート）があればその
+タイトルを使い、なければセグメントをタイトルケース（先頭大文字）にして
+代用します。最後のパンくずはそのノート自身で、パーマリンクへリンクします。
+
+`entry.html` と、コンテンツルートが描画するキャッシュ済みの
+`PostContent.html` の両方を更新するため、生成ページとフィードの両方に
+ナビゲーションが反映されます。
+
+## JSON-LD
+
+`breadcrumbs()` は階層的な BreadcrumbList を `entry.headTags` の
+`<script type="application/ld+json">` として提供します。Site シェルがこれを
+文書の `<head>` に描画します（リファレンスアプリの `_renderer.tsx` は
+`entry.headTags` を描画します）。アイテムの URL は設定の `baseUrl` に基づき
+絶対 URL に変換されます。
+
+`seo` プラグインも有効な場合、seo 側の記事 JSON-LD に 2 階層の
+BreadcrumbList（`ホーム / ノート`）が含まれます。この 2 つは共存するため、
+BreadcrumbList の重複を避けたい Site は記事ページで seo の暫定版を除去して
+ください（リファレンスアプリのコンテンツルートで実施例を確認できます）。
+無効にする場合は本プラグインの `jsonLd: false` も利用できます。
+
+## 使い方
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { breadcrumbs } from "@riebeckite/plugin-breadcrumbs";
+
+export default defineConfig({
+  // ...
+  plugins: [breadcrumbs()],
+});
+```
+
+## オプション
+
+| オプション | 型 | 既定値 | 説明 |
+| ---------- | -- | ------ | ---- |
+| `homeLabel` | `string` | サイトタイトル | ホームのパンくずラベル |
+| `className` | `string` | `"rb-breadcrumbs"` | ルート要素の CSS クラス |
+| `ariaLabel` | `string` | `"Breadcrumbs"` | ナビゲーションのアクセシブル名 |
+| `separator` | `string` | `"/"` | パンくず間の文字 |
+| `jsonLd` | `boolean` | `true` | BreadcrumbList スクリプトを出力・置換する |
+
+```ts
+breadcrumbs({
+  homeLabel: "ブログ",
+  separator: "›",
+});
+```
+
+## 出力
+
+```html
+<nav class="rb-breadcrumbs" data-breadcrumbs aria-label="Breadcrumbs">
+  <ol>
+    <li class="rb-breadcrumbs__item">
+      <a class="rb-breadcrumbs__link" href="/">ブログ</a>
+      <span class="rb-breadcrumbs__separator" aria-hidden="true">/</span>
+    </li>
+    <li class="rb-breadcrumbs__item">
+      <a class="rb-breadcrumbs__link" href="/folder">フォルダ</a>
+      <span class="rb-breadcrumbs__separator" aria-hidden="true">/</span>
+    </li>
+    <li class="rb-breadcrumbs__item">
+      <span class="rb-breadcrumbs__current" aria-current="page">ノート</span>
+    </li>
+  </ol>
+</nav>
+```
+
+## スタイル
+
+パッケージに `style.css` が含まれます。他のプラグインと同じように読み込みます。
+
+```ts
+import "@riebeckite/plugin-breadcrumbs/style.css";
+```
+
+## エクスポート
+
+- `breadcrumbs(options?)` — プラグインファクトリ
+- `breadcrumbsPlugin` — `breadcrumbs` のエイリアス
+- `resolveBreadcrumbsOptions(options?)` — オプションの既定値を適用する
+- `buildBreadcrumbItems({ manifest, entry, config, homeLabel })` — パンくず列を組み立てる
+- `renderBreadcrumbNav(items, options)` — ナビゲーション HTML を生成する
+- `buildBreadcrumbJsonLd(config, items)` — JSON-LD オブジェクトを生成する
+- `injectBreadcrumbNav(html, nav)` / `injectBreadcrumbJsonLd(html, schema)` — HTML 注入ヘルパー
+- 型: `BreadcrumbsOptions`, `ResolvedBreadcrumbsOptions`, `BreadcrumbItem`
+
+## 制約
+
+- パンくず列はビルド時に確定します。再ビルドすれば常に正しく再計算されます。
+- スラッグ階層のみを参照します。frontmatter の並び順や series プラグインの
+  順序は意図的に考慮しません。

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import type { BreadcrumbsOptions } from "./src/types.js";
+export { buildBreadcrumbItems } from "./src/breadcrumbs.js";
+export { resolveBreadcrumbsOptions } from "./src/options.js";
+export { BREADCRUMBS_ATTRIBUTE, buildBreadcrumbHeadTag, buildBreadcrumbJsonLd, hasBreadcrumbHeadTag, injectBreadcrumbNav, renderBreadcrumbNav, } from "./src/render.js";
+export type { BreadcrumbItem, BreadcrumbsOptions, ResolvedBreadcrumbsOptions, } from "./src/types.js";
+export declare const BREADCRUMBS_PLUGIN_NAME = "breadcrumbs";
+/**
+ * Slug-hierarchy breadcrumbs for Riebeckite notes.
+ *
+ * For every published entry it derives a trail from the note's slug and
+ * inserts a `<nav>` at the top of both `entry.html` and the cached
+ * `PostContent.html` that the content route renders. The hierarchical
+ * BreadcrumbList JSON-LD is contributed through `entry.headTags` so the Site
+ * shell can render it in the document `<head>`. No client runtime is required.
+ */
+export declare function breadcrumbs(options?: BreadcrumbsOptions): import("@riebeckite/core").RiebeckitePlugin<BreadcrumbsOptions>;
+/** Alias matching the `*Plugin` suffix used by other plugin factories. */
+export declare const breadcrumbsPlugin: typeof breadcrumbs;

package/dist/index.js

@@ -0,0 +1,191 @@
+// index.ts
+import {
+  createStyleAsset,
+  definePlugin
+} from "@riebeckite/core";
+
+// src/breadcrumbs.ts
+function buildBreadcrumbItems(args) {
+  const { manifest, entry, config, homeLabel } = args;
+  const segments = entry.slug.split("/").filter(Boolean);
+  if (segments.length === 0) return [];
+  const items = [];
+  const homeName = homeLabel || config.site.title;
+  if (homeName) items.push({ name: homeName, url: "/" });
+  for (let index = 0; index < segments.length - 1; index++) {
+    const folderSlug = segments.slice(0, index + 1).join("/");
+    const folderEntry = manifest.bySlug.get(folderSlug);
+    items.push({
+      name: folderEntry?.title ?? titleCaseSegment(segments[index]),
+      url: `/${folderSlug}`
+    });
+  }
+  items.push({ name: entry.title, url: entry.permalink });
+  return items;
+}
+function titleCaseSegment(segment) {
+  return segment.length === 0 ? segment : segment.charAt(0).toUpperCase() + segment.slice(1);
+}
+
+// src/options.ts
+function resolveBreadcrumbsOptions(options) {
+  return {
+    homeLabel: options?.homeLabel?.trim() || "",
+    className: options?.className?.trim() || "rb-breadcrumbs",
+    ariaLabel: options?.ariaLabel?.trim() || "Breadcrumbs",
+    separator: options?.separator ?? "/",
+    jsonLd: options?.jsonLd ?? true
+  };
+}
+
+// src/render.ts
+import {
+  escapeHtml,
+  escapeHtmlAttribute
+} from "@riebeckite/core";
+
+// src/url.ts
+function buildAbsoluteUrl(config, pathOrUrl) {
+  if (!pathOrUrl) return config.site.baseUrl;
+  if (/^https?:\/\//.test(pathOrUrl)) return pathOrUrl;
+  return new URL(
+    pathOrUrl,
+    config.site.baseUrl || "https://example.com"
+  ).toString();
+}
+
+// src/render.ts
+var BREADCRUMBS_ATTRIBUTE = "data-breadcrumbs";
+function renderBreadcrumbNav(items, options) {
+  if (items.length === 0) return "";
+  const className = escapeHtmlAttribute(options.className);
+  const label = escapeHtmlAttribute(options.ariaLabel);
+  const separator = escapeHtml(options.separator);
+  const listItems = items.map((item, index) => {
+    const isLast = index === items.length - 1;
+    const crumb = isLast ? `<span class="${className}__current" aria-current="page">${escapeHtml(
+      item.name
+    )}</span>` : `<a class="${className}__link" href="${escapeHtmlAttribute(
+      item.url
+    )}">${escapeHtml(item.name)}</a>`;
+    const trailing = isLast ? "" : `<span class="${className}__separator" aria-hidden="true">${separator}</span>`;
+    return `<li class="${className}__item">${crumb}${trailing}</li>`;
+  }).join("");
+  return `<nav class="${className}" ${BREADCRUMBS_ATTRIBUTE} aria-label="${label}"><ol>${listItems}</ol></nav>`;
+}
+function buildBreadcrumbJsonLd(config, items) {
+  return {
+    "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    itemListElement: items.map((item, index) => ({
+      "@type": "ListItem",
+      position: index + 1,
+      name: item.name,
+      item: buildAbsoluteUrl(config, item.url)
+    }))
+  };
+}
+function buildBreadcrumbHeadTag(schema) {
+  return {
+    tag: "script",
+    attrs: { type: "application/ld+json" },
+    children: JSON.stringify(schema)
+  };
+}
+function hasBreadcrumbHeadTag(headTags) {
+  return headTags?.some(
+    (tag) => tag.tag === "script" && typeof tag.children === "string" && tag.children.includes('"@type":"BreadcrumbList"')
+  ) ?? false;
+}
+function injectBreadcrumbNav(html, nav) {
+  if (nav === "" || html.includes(BREADCRUMBS_ATTRIBUTE)) return html;
+  const article = /<article\b[^>]*>/i.exec(html);
+  if (article) {
+    const end = article.index + article[0].length;
+    return `${html.slice(0, end)}${nav}${html.slice(end)}`;
+  }
+  const body = /<body\b[^>]*>/i.exec(html);
+  if (body) {
+    const end = body.index + body[0].length;
+    return `${html.slice(0, end)}${nav}${html.slice(end)}`;
+  }
+  return `${nav}
+${html}`;
+}
+
+// index.ts
+var BREADCRUMBS_PLUGIN_NAME = "breadcrumbs";
+function breadcrumbs(options = {}) {
+  const resolved = resolveBreadcrumbsOptions(options);
+  const processed = /* @__PURE__ */ new Map();
+  return definePlugin({
+    name: BREADCRUMBS_PLUGIN_NAME,
+    options,
+    validateOptions: validateBreadcrumbsOptions,
+    onPostProcessed: (context) => {
+      processed.set(context.slug, context.content);
+    },
+    onManifestCreated: (context) => {
+      const { manifest } = context;
+      for (const entry of manifest.entries) {
+        if (entry.html.includes(BREADCRUMBS_ATTRIBUTE)) continue;
+        const items = buildBreadcrumbItems({
+          manifest,
+          entry,
+          config: context.config,
+          homeLabel: resolved.homeLabel
+        });
+        if (items.length === 0) continue;
+        let html = entry.html;
+        const nav = renderBreadcrumbNav(items, resolved);
+        html = injectBreadcrumbNav(html, nav);
+        if (resolved.jsonLd) {
+          const schema = buildBreadcrumbJsonLd(context.config, items);
+          if (!hasBreadcrumbHeadTag(entry.headTags)) {
+            entry.headTags = [
+              ...entry.headTags ?? [],
+              buildBreadcrumbHeadTag(schema)
+            ];
+          }
+        }
+        entry.html = html;
+        const content = processed.get(entry.slug);
+        if (content) content.html = html;
+      }
+      processed.clear();
+    },
+    assets: [createStyleAsset(BREADCRUMBS_PLUGIN_NAME)]
+  });
+}
+var breadcrumbsPlugin = breadcrumbs;
+function validateBreadcrumbsOptions(options) {
+  if (!options) return [];
+  const issues = [];
+  const assertNonEmptyString = (key) => {
+    const value = options[key];
+    if (value !== void 0 && (typeof value !== "string" || value.trim() === "")) {
+      issues.push({ path: key, message: "Expected a non-empty string." });
+    }
+  };
+  assertNonEmptyString("homeLabel");
+  assertNonEmptyString("className");
+  assertNonEmptyString("ariaLabel");
+  assertNonEmptyString("separator");
+  if (options.jsonLd !== void 0 && typeof options.jsonLd !== "boolean") {
+    issues.push({ path: "jsonLd", message: "Expected a boolean." });
+  }
+  return issues;
+}
+export {
+  BREADCRUMBS_ATTRIBUTE,
+  BREADCRUMBS_PLUGIN_NAME,
+  breadcrumbs,
+  breadcrumbsPlugin,
+  buildBreadcrumbHeadTag,
+  buildBreadcrumbItems,
+  buildBreadcrumbJsonLd,
+  hasBreadcrumbHeadTag,
+  injectBreadcrumbNav,
+  renderBreadcrumbNav,
+  resolveBreadcrumbsOptions
+};

package/dist/src/breadcrumbs.d.ts

@@ -0,0 +1,18 @@
+import type { ContentManifest, ContentManifestEntry, ResolvedRiebeckiteConfig } from "@riebeckite/core";
+import type { BreadcrumbItem } from "./types.js";
+export type BuildBreadcrumbItemsArgs = {
+    manifest: ContentManifest;
+    entry: ContentManifestEntry;
+    config: ResolvedRiebeckiteConfig;
+    homeLabel: string;
+};
+/**
+ * Builds the breadcrumb trail for a note from its slug hierarchy.
+ *
+ * The first crumb is always the site home (the site title unless the consumer
+ * provided a `homeLabel`); each intermediate slug segment becomes a crumb
+ * pointing at the folder's own URL. When the folder has an index note of its
+ * own, that note's title is used for the crumb instead of the raw segment.
+ * The final crumb is the note itself and points at its permalink.
+ */
+export declare function buildBreadcrumbItems(args: BuildBreadcrumbItemsArgs): BreadcrumbItem[];

package/dist/src/options.d.ts

@@ -0,0 +1,2 @@
+import type { BreadcrumbsOptions, ResolvedBreadcrumbsOptions } from "./types.js";
+export declare function resolveBreadcrumbsOptions(options: BreadcrumbsOptions | undefined): ResolvedBreadcrumbsOptions;

package/dist/src/render.d.ts

@@ -0,0 +1,34 @@
+import { type PluginHeadTag, type ResolvedRiebeckiteConfig } from "@riebeckite/core";
+import type { BreadcrumbItem, ResolvedBreadcrumbsOptions } from "./types.js";
+/** Boolean attribute that marks the generated navigation for tests and styling. */
+export declare const BREADCRUMBS_ATTRIBUTE = "data-breadcrumbs";
+/**
+ * Renders the breadcrumb trail as a navigation landmark. Returns an empty
+ * string when there is nothing to show, so callers can leave HTML untouched.
+ */
+export declare function renderBreadcrumbNav(items: readonly BreadcrumbItem[], options: ResolvedBreadcrumbsOptions): string;
+/**
+ * Builds the BreadcrumbList schema.org JSON-LD object from the resolved
+ * trail. Item URLs are made absolute against the configured site base URL.
+ */
+export declare function buildBreadcrumbJsonLd(config: ResolvedRiebeckiteConfig, items: readonly BreadcrumbItem[]): Record<string, unknown>;
+/**
+ * Builds the BreadcrumbList JSON-LD `<script>` head tag so the Site shell can
+ * render it in the document `<head>` (see the `headTags` entry mechanism).
+ */
+export declare function buildBreadcrumbHeadTag(schema: Record<string, unknown>): PluginHeadTag;
+/**
+ * True when the entry already carries a BreadcrumbList JSON-LD head tag, so
+ * repeated plugin passes do not emit duplicates.
+ */
+export declare function hasBreadcrumbHeadTag(headTags: readonly PluginHeadTag[] | undefined): boolean;
+/**
+ * Places the completed navigation at the top of the note.
+ *
+ * When the HTML is a full page (it contains an `<article>` or `<body>` tag)
+ * the nav is inserted right after that opening tag. The manifest `html` we
+ * operate on is normally a content fragment the Site wraps in its own
+ * `<article>`, in which case the nav is simply prepended so it renders above
+ * the note's title.
+ */
+export declare function injectBreadcrumbNav(html: string, nav: string): string;

package/dist/src/types.d.ts

@@ -0,0 +1,31 @@
+/** One crumb in the generated breadcrumb trail. */
+export type BreadcrumbItem = {
+    name: string;
+    url: string;
+};
+export type BreadcrumbsOptions = {
+    /**
+     * Label for the site-wide home crumb. When omitted, the site title from the
+     * resolved config (`site.title`) is used.
+     */
+    homeLabel?: string;
+    /** Class name applied to the nav and its child elements. */
+    className?: string;
+    /** Accessible name for the navigation landmark. */
+    ariaLabel?: string;
+    /** Text placed between siblings (defaults to "/"). */
+    separator?: string;
+    /**
+     * Emit a BreadcrumbList JSON-LD script. When the seo plugin already
+     * rendered one, its list is replaced with the hierarchical trail
+     * (defaults to `true`).
+     */
+    jsonLd?: boolean;
+};
+export type ResolvedBreadcrumbsOptions = {
+    homeLabel: string;
+    className: string;
+    ariaLabel: string;
+    separator: string;
+    jsonLd: boolean;
+};

package/dist/src/url.d.ts

@@ -0,0 +1,2 @@
+import type { ResolvedRiebeckiteConfig } from "@riebeckite/core";
+export declare function buildAbsoluteUrl(config: ResolvedRiebeckiteConfig, pathOrUrl: string): string;

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@riebeckite/plugin-breadcrumbs",
+  "version": "0.0.5",
+  "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.5"
+  },
+  "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/breadcrumbs"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Slug-hierarchy breadcrumb navigation for Riebeckite.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "breadcrumbs",
+    "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,39 @@
+.rb-breadcrumbs {
+  margin-block: 0 0.75rem;
+}
+
+.rb-breadcrumbs ol {
+  display: flex;
+  flex-wrap: wrap;
+  align-items: center;
+  gap: 0.375rem;
+  list-style: none;
+  margin: 0;
+  padding: 0;
+}
+
+.rb-breadcrumbs__item {
+  display: inline-flex;
+  align-items: center;
+  gap: 0.375rem;
+}
+
+.rb-breadcrumbs__link {
+  color: var(--rb-color-muted, inherit);
+  text-decoration: none;
+}
+
+.rb-breadcrumbs__link:hover {
+  color: var(--rb-color-accent, inherit);
+  text-decoration: underline;
+}
+
+.rb-breadcrumbs__current {
+  color: var(--rb-color-ink, inherit);
+  font-weight: 600;
+}
+
+.rb-breadcrumbs__separator {
+  color: var(--rb-color-muted, inherit);
+  opacity: 0.6;
+}