@riebeckite/plugin-series 0.0.31 → 0.0.33

package/README.md

@@ -8,6 +8,10 @@ order, with the current part marked and previous/next links.
 
 [日本語](./README_ja.md)
 
+## Live example
+
+The [Plugins in depth](/series/plugins-in-depth-en) series page lists its articles in order and shows previous/next navigation on each one.
+
 ## Overview
 
 `series()` reads series metadata from frontmatter, groups every matching
@@ -91,7 +95,7 @@ to percent-encoding. Set `basePath` to match a custom routing scheme, or pass
 
 ## Exports
 
-- `series(options?)` / `seriesPlugin(options?)` — plugin factory
+- `series(options?)` / `series(options?)` — plugin factory
 - `buildSeriesIndex(manifest, name, options?)` — ordered members for one series
   (`SeriesIndex | null`); useful for landing pages
 - `renderSeriesIndex(manifest, name, options?)` — standalone `<section>` block

package/README_ja.md

@@ -6,11 +6,15 @@
 
 [English](./README.md)
 
+## 実行例
+
+[Plugins in depth](/series/plugins-in-depth-en) のシリーズページでは、記事が順番に並び、各記事に前後のナビゲーションが表示されます。
+
 ## 概要
 
 `series()` は frontmatter からシリーズ情報を読み取り、該当するノートをグループ化して並べ替えたうえで、各ノートの HTML に `<nav class="rb-series">` ブロックを追加します。リンクには Core が解決したパーマリンクを使うため、`permalink` プラグインなどとも併用できます。1 件だけのシリーズにはナビゲーションを出力しません。
 
-また page type を登録し、一覧ページを `/series`、シリーズごとのランディングページを `/series/<name>` に生成します。どちらも公開対象（discoverable）の manifest から組み立てるため、非公開・下書き・予約投稿のノートは現れません。
+またページ種別を登録し、一覧ページを `/series`、シリーズごとのランディングページを `/series/<name>` に生成します。どちらも公開対象（discoverable）のマニフェストから組み立てるため、非公開・下書き・予約投稿のノートは現れません。
 
 このプラグインはビルド時のみ動作し、クライアント用のランタイムは持ちません（スタイルシートのみを登録します）。
 
@@ -56,17 +60,17 @@ series_order: 2
 | `positionLabel` | `boolean` | `false` | 現在の記事に「Part N of M」を付ける。 |
 | `basePath` | `string` | `"/series"` | 生成するページの基準パス。空文字にすると生成しない。 |
 
-## 表示
+## 記事に差し込まれるシリーズナビゲーション
 
 2 件以上あるシリーズの各ノートには、記事の下にシリーズナビゲーションが実際に描画されます。リンクと現在位置は、上の frontmatter から計算します。
 
-テキストと属性はすべてエスケープします。生成した HTML は manifest の entry と処理済みコンテンツの両方へ書き戻すため、ページのルート表示・フィード・検索でも同じマークアップになります。
+テキストと属性はすべてエスケープします。生成した HTML はマニフェストのエントリと処理済みコンテンツの両方へ書き戻すため、ページのルート表示・フィード・検索でも同じマークアップになります。
 
-## ページタイプ
+## ページ種別
 
-プラグインは 2 つの page type を登録します。どちらも `manifest.discoverableEntries` から組み立てるため、非公開のノートは含まれません。
+プラグインは 2 つのページ種別を登録します。どちらも `manifest.discoverableEntries` から組み立てるため、非公開のノートは含まれません。
 
-| page type | パス | 出力 |
+| ページ種別 | パス | 出力 |
 | --------- | ---- | ---- |
 | `series-list` | `<basePath>`（`/series`） | 各シリーズをランディングページへのリンク付きで並べた `<section class="rb-series rb-series--list">`。シリーズが 1 つ以上あるときだけ生成。 |
 | `series-index` | `<basePath>/<name>`（`/series/<name>`） | 1 つのシリーズの `renderSeriesIndex()` セクション。既存の並び順をそのまま使う。 |
@@ -75,7 +79,7 @@ series_order: 2
 
 ## 公開 API
 
-- `series(options?)` / `seriesPlugin(options?)`：プラグインファクトリ
+- `series(options?)` / `series(options?)`：プラグインファクトリ
 - `buildSeriesIndex(manifest, name, options?)`：1 つのシリーズの並び順付きメンバー（`SeriesIndex | null`）。ランディングページ向け
 - `renderSeriesIndex(manifest, name, options?)`：シリーズ全体の `<section>` ブロック
 - `renderSeriesList(manifest, options?, label?)`：全シリーズを並べた `<section>` ブロック。無ければ `""`

package/dist/components/series-navigation.js

@@ -38,7 +38,16 @@ function collectSeriesIndexes(manifest, options = {}) {
   const indexes = [];
   for (const [name, entries] of groups) {
     const members = [...entries].sort((a, b) => compareEntries(a, b, resolved)).map((entry) => toMember(manifest, entry, resolved, name));
-    indexes.push({ name, title: titles.get(name) ?? name, members });
+    const languages = new Set(
+      entries.map((entry) => entry.publicLocation.language).filter((language2) => Boolean(language2))
+    );
+    const language = languages.size === 1 ? [...languages][0] : void 0;
+    indexes.push({
+      name,
+      title: titles.get(name) ?? name,
+      members,
+      ...language ? { language } : {}
+    });
   }
   return indexes;
 }

package/dist/index.d.ts

@@ -14,7 +14,6 @@ export type { ResolvedSeriesOptions, SeriesIndex, SeriesMember, SeriesOptions, }
  * fall back to `date`, then `title`, then `slug` for deterministic results.
  */
 export declare function series(options?: SeriesOptions): import("@riebeckite/core").RiebeckitePlugin<SeriesOptions>;
-export declare const seriesPlugin: typeof series;
 /** Convenience re-export so tooling can resolve options without the factory. */
 export { resolveSeriesOptions };
 /** The default class name used by the plugin stylesheet. */

package/dist/index.js

@@ -40,7 +40,16 @@ function collectSeriesIndexes(manifest, options = {}) {
   const indexes = [];
   for (const [name, entries] of groups) {
     const members = [...entries].sort((a, b) => compareEntries(a, b, resolved)).map((entry) => toMember(manifest, entry, resolved, name));
-    indexes.push({ name, title: titles.get(name) ?? name, members });
+    const languages = new Set(
+      entries.map((entry) => entry.publicLocation.language).filter((language2) => Boolean(language2))
+    );
+    const language = languages.size === 1 ? [...languages][0] : void 0;
+    indexes.push({
+      name,
+      title: titles.get(name) ?? name,
+      members,
+      ...language ? { language } : {}
+    });
   }
   return indexes;
 }
@@ -441,7 +450,8 @@ function series(options = {}) {
             type: "series-index",
             pathname,
             title: index.title,
-            body
+            body,
+            ...index.language ? { language: index.language } : {}
           };
         }
       }
@@ -449,7 +459,6 @@ function series(options = {}) {
     assets: [createStyleAsset("series", "@riebeckite/plugin-series/style.css")]
   });
 }
-var seriesPlugin = series;
 function validateSeriesOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -486,6 +495,5 @@ export {
   resolveSeriesOptions,
   series,
   seriesLandingPath,
-  seriesPlugin,
   seriesSlug
 };

package/dist/src/series.d.ts

@@ -1,7 +1,5 @@
 import { type ContentManifest, type Diagnostic, type PluginDataHelper, type PublicContentEntry, type PublicContentView } from "@riebeckite/core";
 import type { ResolvedSeriesOptions, SeriesIndex, SeriesOptions } from "./types.js";
-/** Base class applied when `options.className` is not set. */
-export declare const DEFAULT_SERIES_CLASS_NAME = "rb-series";
 export declare const DEFAULT_SERIES_BASE_PATH = "/series";
 /** Applies defaults to the user-supplied options. */
 export declare function resolveSeriesOptions(options?: SeriesOptions): ResolvedSeriesOptions;

package/dist/src/types.d.ts

@@ -42,4 +42,6 @@ export type SeriesIndex = {
     title: string;
     /** Members sorted by `order`, then date, title, and slug. */
     members: SeriesMember[];
+    /** Language shared by every member, or `undefined` for mixed languages. */
+    language?: string;
 };

package/package.json

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