@riebeckite/plugin-breadcrumbs 0.0.14 → 0.0.16

package/README.md

@@ -20,8 +20,9 @@ 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.
+The plugin injects the nav into the manifest entry's HTML. Core synchronizes
+that HTML with the content the route renders, so the nav appears on generated
+pages and in feeds.
 
 ## JSON-LD
 
@@ -113,4 +114,5 @@ import "@riebeckite/plugin-breadcrumbs/style.css";
 
 ## See also
 
-- [Plugin guide](../../../docs/en/reference/plugin-api.md)
+- [Plugin guide](../../../docs/en/docs/reference/plugin-api.md)
+

package/README_ja.md

@@ -20,8 +20,8 @@ JavaScript は不要です。
 タイトルを使い、なければセグメントをタイトルケース（先頭大文字）にして
 代用します。最後のパンくずはそのノート自身で、パーマリンクへリンクします。
 
-`entry.html` と、コンテンツルートが描画するキャッシュ済みの
-`PostContent.html` の両方を更新するため、生成ページとフィードの両方に
+マニフェストエントリの HTML にナビゲーションを挿入します。Core がその HTML を
+コンテンツルートの描画 HTML と同期するため、生成ページとフィードの両方に
 ナビゲーションが反映されます。
 
 ## JSON-LD
@@ -112,6 +112,6 @@ import "@riebeckite/plugin-breadcrumbs/style.css";
 - スラッグ階層のみを参照します。frontmatter の並び順や series プラグインの
   順序は意図的に考慮しません。
 
-## ????
+## 関連リンク
 
-- [?????????](../../../docs/ja/reference/plugin-api.md)
+- [プラグイン API](../../../docs/ja/docs/reference/plugin-api.md)

package/dist/index.d.ts

@@ -5,13 +5,13 @@ export { BREADCRUMBS_ATTRIBUTE, buildBreadcrumbHeadTag, buildBreadcrumbJsonLd, h
 export type { BreadcrumbItem, BreadcrumbsOptions, ResolvedBreadcrumbsOptions, } from "./src/types.js";
 export declare const BREADCRUMBS_PLUGIN_NAME = "breadcrumbs";
 /**
- * Slug-hierarchy breadcrumbs for Riebeckite notes.
+ * Public-location 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.
+ * For every published entry it derives a trail from the note's canonical public location and
+ * inserts a `<nav>` at the top of the manifest entry HTML, which is the final
+ * rendering source. 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. */

package/dist/index.js

@@ -5,24 +5,40 @@ import {
 } from "@riebeckite/core";
 
 // src/breadcrumbs.ts
+import { resolvePublicFolderLocation } from "@riebeckite/core";
 function buildBreadcrumbItems(args) {
   const { manifest, entry, config, homeLabel } = args;
-  const segments = entry.slug.split("/").filter(Boolean);
-  if (segments.length === 0) return [];
+  if (!entry.slug) return [];
+  const segments = publicPathSegments(entry.publicLocation.permalink);
   const items = [];
   const homeName = homeLabel || config.site.title;
-  if (homeName) items.push({ name: homeName, url: "/" });
+  if (homeName) pushBreadcrumbItem(items, { name: homeName, url: "/" });
+  if (segments.length === 0) return items;
   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}`
+    const pathname = `/${segments.slice(0, index + 1).join("/")}`;
+    const location = resolvePublicFolderLocation(manifest, pathname);
+    pushBreadcrumbItem(items, {
+      name: location.type === "content" ? location.entry.title : titleCaseSegment(segments[index]),
+      ...location.type === "content" ? { url: location.entry.publicLocation.permalink } : location.type === "generated" ? { url: location.pathname } : {}
     });
   }
-  items.push({ name: entry.title, url: entry.permalink });
+  pushBreadcrumbItem(items, {
+    name: entry.title,
+    url: entry.publicLocation.permalink
+  });
   return items;
 }
+function pushBreadcrumbItem(items, item) {
+  const previous = items.at(-1);
+  if (previous?.name === item.name) {
+    items[items.length - 1] = item;
+    return;
+  }
+  items.push(item);
+}
+function publicPathSegments(permalink) {
+  return permalink.split("/").filter(Boolean);
+}
 function titleCaseSegment(segment) {
   return segment.length === 0 ? segment : segment.charAt(0).toUpperCase() + segment.slice(1);
 }
@@ -66,7 +82,7 @@ function renderBreadcrumbNav(items, options) {
     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(
+    )}</span>` : !item.url ? `<span class="${className}__text">${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>`;
@@ -82,7 +98,7 @@ function buildBreadcrumbJsonLd(config, items) {
       "@type": "ListItem",
       position: index + 1,
       name: item.name,
-      item: buildAbsoluteUrl(config, item.url)
+      ...item.url ? { item: buildAbsoluteUrl(config, item.url) } : {}
     }))
   };
 }
@@ -118,18 +134,20 @@ ${html}`;
 var BREADCRUMBS_PLUGIN_NAME = "breadcrumbs";
 function breadcrumbs(options = {}) {
   const resolved = resolveBreadcrumbsOptions(options);
-  const processed = /* @__PURE__ */ new Map();
   return definePlugin({
     name: BREADCRUMBS_PLUGIN_NAME,
+    optional: ["content.folder-pages"],
+    processedContentCache: {
+      version: "breadcrumbs-v1",
+      dependencyMode: "none"
+    },
+    outputDependencies: [{ type: "global" }],
     options,
     validateOptions: validateBreadcrumbsOptions,
-    onPostProcessed: (context) => {
-      processed.set(context.slug, context.content);
-    },
     onManifestCreated: (context) => {
       const { config, manifest } = context;
       if (!config) return;
-      for (const entry of manifest.entries) {
+      for (const entry of manifest.publicEntries) {
         if (entry.html.includes(BREADCRUMBS_ATTRIBUTE)) continue;
         const items = buildBreadcrumbItems({
           manifest,
@@ -151,10 +169,7 @@ function breadcrumbs(options = {}) {
           }
         }
         entry.html = html;
-        const content = processed.get(entry.slug);
-        if (content) content.html = html;
       }
-      processed.clear();
     },
     assets: [createStyleAsset(BREADCRUMBS_PLUGIN_NAME)]
   });

package/dist/src/breadcrumbs.d.ts

@@ -6,13 +6,4 @@ export type BuildBreadcrumbItemsArgs = {
     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/types.d.ts

@@ -1,7 +1,7 @@
 /** One crumb in the generated breadcrumb trail. */
 export type BreadcrumbItem = {
     name: string;
-    url: string;
+    url?: string;
 };
 export type BreadcrumbsOptions = {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-breadcrumbs",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,11 +15,11 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.14"
+    "@riebeckite/core": "0.0.16"
   },
   "devDependencies": {
     "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.14"
+    "@riebeckite/test": "0.0.16"
   },
   "publishConfig": {
     "access": "public"