@riebeckite/plugin-breadcrumbs 0.0.31 → 0.0.33

package/README.md

@@ -9,6 +9,10 @@ No client-side JavaScript is required.
 
 [日本語](./README_ja.md)
 
+## Live example
+
+The breadcrumb trail above the article — **Riebeckite / Docs / Plugins / Breadcrumbs** — is this plugin's output. It is built from the page's folder and title, and the same trail is emitted as `BreadcrumbList` JSON-LD.
+
 ## Overview
 
 `breadcrumbs()` reads the entry's slug, splits it into segments, and produces a
@@ -85,7 +89,7 @@ import "@riebeckite/plugin-breadcrumbs/style.css";
 ## Exports
 
 - `breadcrumbs(options?)` — plugin factory
-- `breadcrumbsPlugin` — alias of `breadcrumbs`
+- `breadcrumbs` — alias of `breadcrumbs`
 - `resolveBreadcrumbsOptions(options?)` — apply option defaults
 - `buildBreadcrumbItems({ manifest, entry, config, homeLabel })` — build the trail
 - `renderBreadcrumbNav(items, options)` — render the navigation HTML

package/README_ja.md

@@ -9,6 +9,10 @@ JavaScript は不要です。
 
 [English](./README.md)
 
+## 実行例
+
+記事の上に表示されている **Riebeckite / Docs / Plugins / Breadcrumbs** が、このプラグインの出力です。ページのフォルダとタイトルから組み立てられ、同じ内容が `BreadcrumbList` の JSON-LD としても出力されます。
+
 ## 仕組み
 
 `breadcrumbs()` はエントリのスラッグを「/」で区切り、必ずサイトのホームから
@@ -19,7 +23,7 @@ JavaScript は不要です。
 
 途中のフォルダはマニフェストと突き合わせて解決します。フォルダ自身に
 インデックスノート（フォルダと同名のスラッグを持つノート）があればその
-タイトルを使い、なければセグメントをタイトルケース（先頭大文字）にして
+タイトルを使い、なければセグメントをタイトルケース（先頭を大文字にする）にして
 代用します。最後のパンくずはそのノート自身で、パーマリンクへリンクします。
 
 マニフェストエントリの HTML にナビゲーションを挿入します。Core がその HTML を
@@ -29,7 +33,7 @@ JavaScript は不要です。
 ## JSON-LD
 
 `breadcrumbs()` は階層的な BreadcrumbList を `entry.headTags` の
-`<script type="application/ld+json">` として提供します。Site シェルがこれを
+`<script type="application/ld+json">` として提供します。サイトシェルがこれを
 文書の `<head>` に描画します（リファレンスアプリの `_renderer.tsx` は
 `entry.headTags` を描画します）。アイテムの URL は設定の `baseUrl` に基づき
 絶対 URL に変換されます。
@@ -37,7 +41,7 @@ JavaScript は不要です。
 `seo` プラグインも有効な場合、seo 側は独自の 2 階層の BreadcrumbList
 （`ホーム / ノート`）を記事 JSON-LD に含めようとします。ページの `headTags`
 を seo 拡張へ渡すと、本プラグインが提供した BreadcrumbList を検出して seo 側の
-暫定版を省略するため、Site 側で調整しなくても BreadcrumbList は 1 つだけに
+暫定版を省略するため、サイト側で調整しなくても BreadcrumbList は 1 つだけに
 なります。本プラグインからの出力自体を止めたい場合は `jsonLd: false` を使います。
 
 ## 使い方
@@ -84,7 +88,7 @@ import "@riebeckite/plugin-breadcrumbs/style.css";
 ## エクスポート
 
 - `breadcrumbs(options?)`：プラグインファクトリ
-- `breadcrumbsPlugin`：`breadcrumbs` のエイリアス
+- `breadcrumbs`：`breadcrumbs` のエイリアス
 - `resolveBreadcrumbsOptions(options?)`：オプションの既定値を適用する
 - `buildBreadcrumbItems({ manifest, entry, config, homeLabel })`：パンくず列を組み立てる
 - `renderBreadcrumbNav(items, options)`：ナビゲーション HTML を生成する

package/dist/components/breadcrumbs.js

@@ -4,24 +4,28 @@ import { html } from "hono/html";
 
 // src/breadcrumbs.ts
 import { resolvePublicFolderLocation } from "@riebeckite/core";
-var getBreadcrumbs = ({ view, entry, homeLabel = "" }) => {
-  if (!view.findRoutableBySlug(entry.slug)) return [];
-  const segments = publicPathSegments(entry.permalink);
+function buildBreadcrumbItems(args) {
+  const { manifest, entry, config, homeLabel } = args;
+  if (!entry.slug) return [];
+  const segments = publicPathSegments(entry.publicLocation.permalink);
   const items = [];
-  if (homeLabel) pushBreadcrumbItem(items, { name: homeLabel, url: "/" });
-  for (let index = 0; index < segments.length - 1; index += 1) {
+  const homeName = homeLabel || config.site.title;
+  if (homeName) pushBreadcrumbItem(items, { name: homeName, url: "/" });
+  if (segments.length === 0) return items;
+  for (let index = 0; index < segments.length - 1; index++) {
     const pathname = `/${segments.slice(0, index + 1).join("/")}`;
-    const target = view.discoverableEntries.find(
-      (candidate) => candidate.permalink === pathname
-    );
+    const location = resolvePublicFolderLocation(manifest, pathname);
     pushBreadcrumbItem(items, {
-      name: target?.title || titleCaseSegment(segments[index]),
-      ...target ? { url: target.permalink } : {}
+      name: location.type === "content" ? location.entry.title : titleCaseSegment(segments[index]),
+      ...location.type === "content" ? { url: location.entry.publicLocation.permalink } : location.type === "generated" ? { url: location.pathname } : {}
     });
   }
-  pushBreadcrumbItem(items, { 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) {
@@ -47,9 +51,10 @@ var Breadcrumbs = (async ({
 }) => {
   const site = useSiteContext();
   const article = useArticleContext();
-  const items = explicitItems ?? (site && article?.entry ? await getBreadcrumbs({
-    view: site.view,
+  const items = explicitItems ?? (site && article?.entry ? buildBreadcrumbItems({
+    manifest: site.manifest,
     entry: article.entry,
+    config: site.config,
     homeLabel: site.config.site.title
   }) : void 0);
   if (!items) return html``;

package/dist/index.d.ts

@@ -16,5 +16,3 @@ export declare const BREADCRUMBS_PLUGIN_NAME = "breadcrumbs";
  * `<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

@@ -37,7 +37,7 @@ var getBreadcrumbs = ({ view, entry, homeLabel = "" }) => {
   for (let index = 0; index < segments.length - 1; index += 1) {
     const pathname = `/${segments.slice(0, index + 1).join("/")}`;
     const target = view.discoverableEntries.find(
-      (candidate) => candidate.permalink === pathname
+      (candidate) => normalizePathname(candidate.permalink) === pathname
     );
     pushBreadcrumbItem(items, {
       name: target?.title || titleCaseSegment(segments[index]),
@@ -58,6 +58,10 @@ function pushBreadcrumbItem(items, item) {
 function publicPathSegments(permalink) {
   return permalink.split("/").filter(Boolean);
 }
+function normalizePathname(pathname) {
+  const segments = publicPathSegments(pathname);
+  return segments.length === 0 ? "/" : `/${segments.join("/")}`;
+}
 function titleCaseSegment(segment) {
   return segment.length === 0 ? segment : segment.charAt(0).toUpperCase() + segment.slice(1);
 }
@@ -160,9 +164,10 @@ var Breadcrumbs = (async ({
 }) => {
   const site = useSiteContext();
   const article = useArticleContext();
-  const items = explicitItems ?? (site && article?.entry ? await getBreadcrumbs({
-    view: site.view,
+  const items = explicitItems ?? (site && article?.entry ? buildBreadcrumbItems({
+    manifest: site.manifest,
     entry: article.entry,
+    config: site.config,
     homeLabel: site.config.site.title
   }) : void 0);
   if (!items) return html``;
@@ -218,7 +223,6 @@ function breadcrumbs(options = {}) {
     ]
   });
 }
-var breadcrumbsPlugin = breadcrumbs;
 function breadcrumbOutputDependencies(entry, manifest) {
   const segments = entry.publicLocation.permalink.split("/").filter(Boolean);
   const dependencies = [];
@@ -261,7 +265,6 @@ export {
   BREADCRUMBS_PLUGIN_NAME,
   breadcrumbs_default as Breadcrumbs,
   breadcrumbs,
-  breadcrumbsPlugin,
   buildBreadcrumbHeadTag,
   buildBreadcrumbItems,
   buildBreadcrumbJsonLd,

package/dist/src/breadcrumbs.d.ts

@@ -1,8 +1,14 @@
-import type { ContentManifest, ContentManifestEntry, PluginDataHelper, PublicContentEntry, PublicContentView, ResolvedRiebeckiteConfig } from "@riebeckite/core";
+import type { ContentManifest, PluginDataHelper, PublicContentEntry, PublicContentView, ResolvedRiebeckiteConfig } from "@riebeckite/core";
 import type { BreadcrumbItem } from "./types.js";
-export type BuildBreadcrumbItemsArgs = {
+type BuildBreadcrumbItemsArgs = {
     manifest: ContentManifest;
-    entry: ContentManifestEntry;
+    entry: {
+        slug: string;
+        title: string;
+        publicLocation: {
+            permalink: string;
+        };
+    };
     config: ResolvedRiebeckiteConfig;
     homeLabel: string;
 };
@@ -12,3 +18,4 @@ export declare const getBreadcrumbs: PluginDataHelper<{
     entry: PublicContentEntry;
     homeLabel?: string;
 }, readonly BreadcrumbItem[]>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-breadcrumbs",
-  "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"