@riebeckite/plugin-breadcrumbs 0.0.32 → 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/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

@@ -223,7 +223,6 @@ function breadcrumbs(options = {}) {
     ]
   });
 }
-var breadcrumbsPlugin = breadcrumbs;
 function breadcrumbOutputDependencies(entry, manifest) {
   const segments = entry.publicLocation.permalink.split("/").filter(Boolean);
   const dependencies = [];
@@ -266,7 +265,6 @@ export {
   BREADCRUMBS_PLUGIN_NAME,
   breadcrumbs_default as Breadcrumbs,
   breadcrumbs,
-  breadcrumbsPlugin,
   buildBreadcrumbHeadTag,
   buildBreadcrumbItems,
   buildBreadcrumbJsonLd,

package/dist/src/breadcrumbs.d.ts

@@ -1,6 +1,6 @@
 import type { ContentManifest, PluginDataHelper, PublicContentEntry, PublicContentView, ResolvedRiebeckiteConfig } from "@riebeckite/core";
 import type { BreadcrumbItem } from "./types.js";
-export type BuildBreadcrumbItemsArgs = {
+type BuildBreadcrumbItemsArgs = {
     manifest: ContentManifest;
     entry: {
         slug: string;
@@ -18,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.32",
+  "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/core": "0.0.32",
-    "@riebeckite/ui": "0.0.32"
+    "@riebeckite/core": "0.0.33",
+    "@riebeckite/ui": "0.0.33",
+    "hono": "^4.12.25"
   },
   "devDependencies": {
-    "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.32"
+    "@riebeckite/test": "0.0.33",
+    "tsx": "^4.22.4"
   },
   "publishConfig": {
     "access": "public"