@riebeckite/plugin-series 0.0.1

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,144 @@
+# @riebeckite/plugin-series
+
+Ordered multi-part posts ("series") for Riebeckite. At build time, notes that
+share a series name get the same generated navigation listing every part in
+order, with the current part marked and previous/next links.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`series()` reads series metadata from frontmatter, groups every matching
+manifest entry, sorts the group, and appends a `<nav class="rb-series">` block
+to each note in the series. Links use the permalinks resolved by Core, so
+plugins such as `permalink` are respected. A single-note series renders no
+navigation block.
+
+The plugin is build-time only: it ships a stylesheet asset and no client
+runtime.
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { series } from "@riebeckite/plugin-series";
+
+export default defineConfig({
+  // ...
+  plugins: [series()],
+});
+```
+
+## Frontmatter contract
+
+| Key | Type | Required | Description |
+| --- | ---- | -------- | ----------- |
+| `series` | `string` | yes | Series name used for grouping. |
+| `series_order` | `number` | recommended | Position within the series (ascending). |
+| `series_title` | `string` | no | Display title for the series heading. |
+
+```yaml
+---
+title: Installing the thing
+series: Build a thing
+series_order: 2
+---
+```
+
+Notes missing a valid `series_order` are still included; they are ordered after
+the numbered parts, using `date`/`created`/`published`, then `title`, then
+`slug`. Ties always resolve deterministically.
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `key` | `string` | `"series"` | Frontmatter key that names the series. |
+| `orderKey` | `string` | `"series_order"` | Frontmatter key holding the numeric order. |
+| `titleKey` | `string` | `"series_title"` | Frontmatter key overriding the series heading. |
+| `heading` | `boolean` | `true` | Render the series heading above the list. |
+| `className` | `string` | `"rb-series"` | Base CSS class for generated markup. |
+| `positionLabel` | `boolean` | `false` | Add a `Part N of M` label for the current note. |
+
+## Output
+
+Each note in a series of two or more parts gets the following block appended to
+its HTML:
+
+```html
+<nav class="rb-series" data-series="Build a thing"
+     aria-label="Series navigation">
+  <p class="rb-series__title">
+    <a class="rb-series__link" href="/build-a-thing">Build a thing</a>
+  </p>
+  <ol class="rb-series__list">
+    <li class="rb-series__item">
+      <a class="rb-series__link" href="/part-1" data-series-order="1">Part 1</a>
+    </li>
+    <li class="rb-series__item">
+      <a class="rb-series__link" href="/part-2" data-series-order="2"
+         aria-current="page">Part 2</a>
+    </li>
+  </ol>
+  <div class="rb-series__nav">
+    <a class="rb-series__prev" rel="prev" href="/part-1">&larr; Part 1</a>
+    <a class="rb-series__next" rel="next" href="/part-3">Part 3 &rarr;</a>
+  </div>
+</nav>
+```
+
+All text and attributes are escaped. The injected HTML is written back to both
+the manifest entry and the processed content object so the page route, feeds,
+and search see the same markup.
+
+## Exports
+
+- `series(options?)` / `seriesPlugin(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
+  for a whole series
+- `renderSeriesNavigation(index, currentSlug, options?)` — a single navigation
+  block
+- `collectSeriesIndexes(manifest, options?)` — every series in first-seen order
+- `resolveSeriesOptions(options?)` — options with defaults applied
+- Types: `SeriesOptions`, `ResolvedSeriesOptions`, `SeriesMember`, `SeriesIndex`
+
+### Series landing page
+
+```ts
+import { buildSeriesIndex, renderSeriesIndex } from "@riebeckite/plugin-series";
+
+// inside a route component, with the resolved manifest:
+const index = buildSeriesIndex(manifest, "Build a thing");
+const html = renderSeriesIndex(manifest, "Build a thing");
+```
+
+## Diagnostics
+
+Emitted with `pluginName: "series"` and `severity: "warning"`:
+
+| Code | Meaning |
+| ---- | ------- |
+| `series-invalid-name` | The series key is present but is not a non-empty string. |
+| `series-missing-order` | The note has no valid numeric order key; fallback ordering is used. |
+| `series-duplicate-order` | Two or more notes share the same `(series, order)` pair. |
+
+## CSS hooks
+
+`style.css` styles `.rb-series`, `.rb-series__title`, `.rb-series__position`,
+`.rb-series__list`, `.rb-series__item`, `.rb-series__nav`, `.rb-series__prev`,
+`.rb-series__next`, and the `.rb-series--index` variant. The current part is
+matched with `.rb-series__item a[aria-current="page"]`.
+
+## Limitations
+
+- A note belongs to exactly one series.
+- A series of one note produces no navigation block.
+- `series_order` must be a finite number; numeric strings are not coerced.
+- The plugin does not generate routes for series; combine
+  `renderSeriesIndex()` with your own page to build a series landing page.
+
+## See also
+
+- [Plugin guide](../../docs/plugins_en.md)

package/README_ja.md

@@ -0,0 +1,125 @@
+# @riebeckite/plugin-series
+
+連載記事（シリーズ）を順番どおりに並べ、各記事へ共通のナビゲーションを差し込むプラグインです。ビルド時に、同じシリーズ名を持つノートをまとめて、目次・現在位置・前後の記事リンクを生成します。
+
+[English](./README.md)
+
+## 概要
+
+`series()` は frontmatter からシリーズ情報を読み取り、該当するノートをグループ化して並べ替えたうえで、各ノートの HTML に `<nav class="rb-series">` ブロックを追加します。リンクには Core が解決したパーマリンクを使うため、`permalink` プラグインなどとも併用できます。1件だけのシリーズにはナビゲーションを出力しません。
+
+このプラグインはビルド時のみ動作し、クライアント用のランタイムは持ちません（スタイルシートのみを登録します）。
+
+## 設定する
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { series } from "@riebeckite/plugin-series";
+
+export default defineConfig({
+  // ...
+  plugins: [series()],
+});
+```
+
+## frontmatter の書き方
+
+| キー | 型 | 必須 | 説明 |
+| ---- | -- | ---- | ---- |
+| `series` | `string` | はい | グループ化に使うシリーズ名。 |
+| `series_order` | `number` | 推奨 | シリーズ内の並び順（昇順）。 |
+| `series_title` | `string` | いいえ | 見出しに表示するシリーズ名。 |
+
+```yaml
+---
+title: 導入編
+series: 何かを作る
+series_order: 2
+---
+```
+
+`series_order` が無い・不正なノートも対象に含まれます。その場合は番号付きの記事の後ろに並び、`date`／`created`／`published`、`title`、`slug` の順で安定して並べ替えます。同点の場合は常に決まった順序になります。
+
+## オプション
+
+| オプション | 型 | 既定値 | 説明 |
+| ---------- | -- | ------ | ---- |
+| `key` | `string` | `"series"` | シリーズ名を持つ frontmatter キー。 |
+| `orderKey` | `string` | `"series_order"` | 並び順の数値を持つ frontmatter キー。 |
+| `titleKey` | `string` | `"series_title"` | 見出しのシリーズ名を上書きするキー。 |
+| `heading` | `boolean` | `true` | リストの上に見出しを表示する。 |
+| `className` | `string` | `"rb-series"` | 生成する HTML の基準クラス名。 |
+| `positionLabel` | `boolean` | `false` | 現在の記事に「Part N of M」を付ける。 |
+
+## 出力
+
+2件以上あるシリーズの各ノートには、次のブロックが HTML の末尾に追加されます。
+
+```html
+<nav class="rb-series" data-series="何かを作る"
+     aria-label="Series navigation">
+  <p class="rb-series__title">
+    <a class="rb-series__link" href="/part-1">何かを作る</a>
+  </p>
+  <ol class="rb-series__list">
+    <li class="rb-series__item">
+      <a class="rb-series__link" href="/part-1" data-series-order="1">導入編</a>
+    </li>
+    <li class="rb-series__item">
+      <a class="rb-series__link" href="/part-2" data-series-order="2"
+         aria-current="page">実装編</a>
+    </li>
+  </ol>
+  <div class="rb-series__nav">
+    <a class="rb-series__prev" rel="prev" href="/part-1">&larr; 導入編</a>
+    <a class="rb-series__next" rel="next" href="/part-3">仕上げ編 &rarr;</a>
+  </div>
+</nav>
+```
+
+テキストと属性はすべてエスケープします。生成した HTML は manifest の entry と処理済みコンテンツの両方へ書き戻すため、ページのルート表示・フィード・検索でも同じマークアップになります。
+
+## 公開 API
+
+- `series(options?)` / `seriesPlugin(options?)` — プラグインファクトリ
+- `buildSeriesIndex(manifest, name, options?)` — 1つのシリーズの並び順付きメンバー（`SeriesIndex | null`）。ランディングページ向け
+- `renderSeriesIndex(manifest, name, options?)` — シリーズ全体の `<section>` ブロック
+- `renderSeriesNavigation(index, currentSlug, options?)` — ナビゲーション1つ分
+- `collectSeriesIndexes(manifest, options?)` — 全シリーズを出現順で取得
+- `resolveSeriesOptions(options?)` — 既定値を適用したオプション
+- 型: `SeriesOptions`, `ResolvedSeriesOptions`, `SeriesMember`, `SeriesIndex`
+
+### シリーズのランディングページ
+
+```ts
+import { buildSeriesIndex, renderSeriesIndex } from "@riebeckite/plugin-series";
+
+// ルートコンポーネント内で、解決済みの manifest を使って:
+const index = buildSeriesIndex(manifest, "何かを作る");
+const html = renderSeriesIndex(manifest, "何かを作る");
+```
+
+## 診断
+
+`pluginName: "series"`、`severity: "warning"` で出力します。
+
+| コード | 意味 |
+| ------ | ---- |
+| `series-invalid-name` | シリーズのキーはあるが、空でない文字列になっていない。 |
+| `series-missing-order` | 有効な数値の並び順キーが無く、代替の順序を使った。 |
+| `series-duplicate-order` | 同じ `(シリーズ, 並び順)` の組を持つノートが複数ある。 |
+
+## CSS フック
+
+`style.css` は `.rb-series`、`.rb-series__title`、`.rb-series__position`、`.rb-series__list`、`.rb-series__item`、`.rb-series__nav`、`.rb-series__prev`、`.rb-series__next`、および `.rb-series--index` をスタイルします。現在の記事は `.rb-series__item a[aria-current="page"]` で判定できます。
+
+## 制限
+
+- 1つのノートが所属できるシリーズは1つだけです。
+- 1件だけのシリーズにはナビゲーションを出力しません。
+- `series_order` は有限の数値である必要があります。数値文字列は変換しません。
+- シリーズ用のルートは生成しません。ランディングページを作る場合は `renderSeriesIndex()` を自前のページと組み合わせてください。
+
+## 関連
+
+- [プラグインガイド](../../docs/plugins_ja.md)

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import { resolveSeriesOptions } from "./src/series.js";
+import type { SeriesOptions } from "./src/types.js";
+export type { ResolvedSeriesOptions, SeriesIndex, SeriesMember, SeriesOptions, } from "./src/types.js";
+export { buildSeriesIndex, collectSeriesIndexes, renderSeriesIndex, renderSeriesNavigation, } from "./src/series.js";
+/**
+ * Series (ordered multi-part posts) for Riebeckite.
+ *
+ * Notes that share a `series` frontmatter value are gathered at build time and
+ * receive the same generated navigation (`<nav class="rb-series">`) listing
+ * every part in order, with the current part marked and previous/next links.
+ * Order is read from `series_order` (configurable); notes without a valid order
+ * 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. */
+export declare const DEFAULT_CLASS_NAME: string;

package/dist/index.js

@@ -0,0 +1,309 @@
+// index.ts
+import {
+  createStyleAsset,
+  definePlugin
+} from "@riebeckite/core";
+
+// src/series.ts
+import {
+  escapeHtml,
+  escapeHtmlAttribute
+} from "@riebeckite/core";
+var DEFAULT_SERIES_CLASS_NAME = "rb-series";
+function resolveSeriesOptions(options = {}) {
+  return {
+    key: options.key ?? "series",
+    orderKey: options.orderKey ?? "series_order",
+    titleKey: options.titleKey ?? "series_title",
+    heading: options.heading ?? true,
+    className: options.className ?? DEFAULT_SERIES_CLASS_NAME,
+    positionLabel: options.positionLabel ?? false
+  };
+}
+function collectSeriesIndexes(manifest, options = {}) {
+  const resolved = resolveSeriesOptions(options);
+  const groups = /* @__PURE__ */ new Map();
+  const titles = /* @__PURE__ */ new Map();
+  for (const entry of manifest.entries) {
+    const name = readSeriesName(entry, resolved.key);
+    if (!name) continue;
+    const group = groups.get(name);
+    if (group) group.push(entry);
+    else groups.set(name, [entry]);
+    if (!titles.has(name)) {
+      const title = readString(entry, resolved.titleKey);
+      if (title) titles.set(name, title);
+    }
+  }
+  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 });
+  }
+  return indexes;
+}
+function buildSeriesIndex(manifest, name, options = {}) {
+  return collectSeriesIndexes(manifest, options).find(
+    (index) => index.name === name
+  ) ?? null;
+}
+function renderSeriesNavigation(index, currentSlug, options = {}) {
+  const resolved = resolveSeriesOptions(options);
+  const cls = resolved.className;
+  const members = index.members;
+  const position = members.findIndex((member) => member.slug === currentSlug);
+  const prev = position > 0 ? members[position - 1] : void 0;
+  const next = position >= 0 && position < members.length - 1 ? members[position + 1] : void 0;
+  const parts = [
+    `<nav class="${escapeHtmlAttribute(cls)}" data-series="${escapeHtmlAttribute(
+      index.name
+    )}" aria-label="Series navigation">`
+  ];
+  if (resolved.heading && members.length > 0) {
+    const label = resolved.positionLabel && position >= 0 ? ` <span class="${escapeHtmlAttribute(
+      cls
+    )}__position">${escapeHtml(formatPosition(position + 1, members.length))}</span>` : "";
+    parts.push(
+      `<p class="${escapeHtmlAttribute(
+        cls
+      )}__title"><a class="${escapeHtmlAttribute(
+        cls
+      )}__link" href="${escapeHtmlAttribute(
+        members[0].permalink
+      )}">${escapeHtml(index.title)}</a>${label}</p>`
+    );
+  }
+  parts.push(`<ol class="${escapeHtmlAttribute(cls)}__list">`);
+  members.forEach((member, i) => {
+    const current = member.slug === currentSlug;
+    const currentAttribute = current ? ' aria-current="page"' : "";
+    const order = member.order ?? i + 1;
+    parts.push(
+      `<li class="${escapeHtmlAttribute(cls)}__item"><a class="${escapeHtmlAttribute(
+        cls
+      )}__link" href="${escapeHtmlAttribute(
+        member.permalink
+      )}" data-series-order="${escapeHtmlAttribute(
+        String(order)
+      )}"${currentAttribute}>${escapeHtml(member.title)}</a></li>`
+    );
+  });
+  parts.push("</ol>");
+  parts.push(`<div class="${escapeHtmlAttribute(cls)}__nav">`);
+  if (prev) {
+    parts.push(
+      `<a class="${escapeHtmlAttribute(
+        cls
+      )}__prev" rel="prev" href="${escapeHtmlAttribute(
+        prev.permalink
+      )}">&larr; ${escapeHtml(prev.title)}</a>`
+    );
+  }
+  if (next) {
+    parts.push(
+      `<a class="${escapeHtmlAttribute(
+        cls
+      )}__next" rel="next" href="${escapeHtmlAttribute(
+        next.permalink
+      )}">${escapeHtml(next.title)} &rarr;</a>`
+    );
+  }
+  parts.push("</div>");
+  parts.push("</nav>");
+  return parts.join("");
+}
+function renderSeriesIndex(manifest, name, options = {}) {
+  const index = buildSeriesIndex(manifest, name, options);
+  if (!index || index.members.length === 0) return "";
+  const resolved = resolveSeriesOptions(options);
+  const cls = resolved.className;
+  const parts = [
+    `<section class="${escapeHtmlAttribute(
+      cls
+    )} ${escapeHtmlAttribute(cls)}--index" data-series="${escapeHtmlAttribute(
+      index.name
+    )}">`,
+    `<h2 class="${escapeHtmlAttribute(cls)}__title">${escapeHtml(
+      index.title
+    )}</h2>`,
+    `<ol class="${escapeHtmlAttribute(cls)}__list">`
+  ];
+  index.members.forEach((member, i) => {
+    const order = member.order ?? i + 1;
+    parts.push(
+      `<li class="${escapeHtmlAttribute(cls)}__item"><a class="${escapeHtmlAttribute(
+        cls
+      )}__link" href="${escapeHtmlAttribute(
+        member.permalink
+      )}" data-series-order="${escapeHtmlAttribute(
+        String(order)
+      )}">${escapeHtml(member.title)}</a></li>`
+    );
+  });
+  parts.push("</ol></section>");
+  return parts.join("");
+}
+function collectSeriesDiagnostics(manifest, options = {}) {
+  const resolved = resolveSeriesOptions(options);
+  const diagnostics = [];
+  const firstByOrder = /* @__PURE__ */ new Map();
+  for (const entry of manifest.entries) {
+    if (!hasFrontmatterKey(entry, resolved.key)) continue;
+    const name = readSeriesName(entry, resolved.key);
+    if (!name) {
+      diagnostics.push({
+        code: "series-invalid-name",
+        severity: "warning",
+        pluginName: "series",
+        slug: entry.slug,
+        message: `Frontmatter \`${resolved.key}\` must be a non-empty string.`
+      });
+      continue;
+    }
+    const order = readSeriesOrder(entry, resolved.orderKey);
+    if (order === void 0) {
+      diagnostics.push({
+        code: "series-missing-order",
+        severity: "warning",
+        pluginName: "series",
+        slug: entry.slug,
+        message: `Note in series \`${name}\` has no numeric \`${resolved.orderKey}\`; it is ordered by date, title, then slug.`,
+        meta: { series: name }
+      });
+      continue;
+    }
+    const orderKey = `${name}\0${order}`;
+    const first = firstByOrder.get(orderKey);
+    if (first) {
+      diagnostics.push({
+        code: "series-duplicate-order",
+        severity: "warning",
+        pluginName: "series",
+        slug: entry.slug,
+        message: `Series \`${name}\` has more than one note with \`${resolved.orderKey}: ${order}\` (also in \`${first.slug}\`).`,
+        meta: { series: name, order }
+      });
+    } else {
+      firstByOrder.set(orderKey, entry);
+    }
+  }
+  return diagnostics;
+}
+function toMember(manifest, entry, resolved, name) {
+  return {
+    slug: entry.slug,
+    title: entry.title || entry.slug,
+    permalink: manifest.bySlug.get(entry.slug)?.permalink ?? entry.permalink,
+    order: readSeriesOrder(entry, resolved.orderKey) ?? null,
+    series: name
+  };
+}
+function compareEntries(a, b, resolved) {
+  const orderA = readSeriesOrder(a, resolved.orderKey) ?? Number.POSITIVE_INFINITY;
+  const orderB = readSeriesOrder(b, resolved.orderKey) ?? Number.POSITIVE_INFINITY;
+  if (orderA !== orderB) return orderA < orderB ? -1 : 1;
+  const dateA = readSeriesDate(a) ?? Number.POSITIVE_INFINITY;
+  const dateB = readSeriesDate(b) ?? Number.POSITIVE_INFINITY;
+  if (dateA !== dateB) return dateA < dateB ? -1 : 1;
+  if (a.title !== b.title) return a.title < b.title ? -1 : 1;
+  if (a.slug !== b.slug) return a.slug < b.slug ? -1 : 1;
+  return 0;
+}
+function readSeriesName(entry, key) {
+  return readString(entry, key);
+}
+function readSeriesOrder(entry, key) {
+  const value = entry.frontmatter[key];
+  if (typeof value === "number" && Number.isFinite(value)) return value;
+  return void 0;
+}
+function readString(entry, key) {
+  const value = entry.frontmatter[key];
+  if (typeof value !== "string") return void 0;
+  const trimmed = value.trim();
+  return trimmed === "" ? void 0 : trimmed;
+}
+function readSeriesDate(entry) {
+  for (const key of ["date", "created", "published"]) {
+    const time = parseDate(entry.frontmatter[key]);
+    if (time !== void 0) return time;
+  }
+  return void 0;
+}
+function parseDate(value) {
+  if (value instanceof Date) {
+    const time = value.getTime();
+    return Number.isFinite(time) ? time : void 0;
+  }
+  if (typeof value === "string") {
+    const time = Date.parse(value);
+    return Number.isNaN(time) ? void 0 : time;
+  }
+  return void 0;
+}
+function hasFrontmatterKey(entry, key) {
+  return Object.hasOwn(entry.frontmatter, key);
+}
+function formatPosition(position, total) {
+  return `Part ${position} of ${total}`;
+}
+
+// index.ts
+function series(options = {}) {
+  const tracked = /* @__PURE__ */ new Map();
+  return definePlugin({
+    name: "series",
+    options,
+    validateOptions: validateSeriesOptions,
+    onPostProcessed: ({ slug, content }) => {
+      tracked.set(slug, content);
+    },
+    onManifestCreated: ({ manifest, diagnostics }) => {
+      diagnostics.push(...collectSeriesDiagnostics(manifest, options));
+      const injected = /* @__PURE__ */ new Set();
+      for (const index of collectSeriesIndexes(manifest, options)) {
+        if (index.members.length < 2) continue;
+        for (const member of index.members) {
+          if (injected.has(member.slug)) continue;
+          const entry = manifest.bySlug.get(member.slug);
+          if (!entry) continue;
+          injected.add(member.slug);
+          const navigation = renderSeriesNavigation(index, member.slug, options);
+          entry.html = `${entry.html}
+${navigation}`;
+          const content = tracked.get(member.slug);
+          if (content) content.html = entry.html;
+        }
+      }
+    },
+    assets: [createStyleAsset("series")]
+  });
+}
+var seriesPlugin = series;
+function validateSeriesOptions(options) {
+  if (!options) return [];
+  const issues = [];
+  for (const key of ["key", "orderKey", "titleKey", "className"]) {
+    const value = options[key];
+    if (value !== void 0 && (typeof value !== "string" || value.trim() === "")) {
+      issues.push({ path: key, message: "Expected a non-empty string." });
+    }
+  }
+  for (const key of ["heading", "positionLabel"]) {
+    if (options[key] !== void 0 && typeof options[key] !== "boolean") {
+      issues.push({ path: key, message: "Expected a boolean." });
+    }
+  }
+  return issues;
+}
+var DEFAULT_CLASS_NAME = resolveSeriesOptions({}).className;
+export {
+  DEFAULT_CLASS_NAME,
+  buildSeriesIndex,
+  collectSeriesIndexes,
+  renderSeriesIndex,
+  renderSeriesNavigation,
+  resolveSeriesOptions,
+  series,
+  seriesPlugin
+};

package/dist/src/series.d.ts

@@ -0,0 +1,31 @@
+import { type ContentManifest, type Diagnostic } 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";
+/** Applies defaults to the user-supplied options. */
+export declare function resolveSeriesOptions(options?: SeriesOptions): ResolvedSeriesOptions;
+/**
+ * Groups every manifest entry that declares a series and returns one
+ * `SeriesIndex` per series, in first-seen order. Members are sorted by
+ * `orderKey`, then the `date`/`created`/`published` frontmatter value, then
+ * `title`, then `slug`, so ties resolve deterministically.
+ */
+export declare function collectSeriesIndexes(manifest: ContentManifest, options?: SeriesOptions): SeriesIndex[];
+/** Returns a single series index, or `null` when no note declares `name`. */
+export declare function buildSeriesIndex(manifest: ContentManifest, name: string, options?: SeriesOptions): SeriesIndex | null;
+/**
+ * Renders the navigation block that is appended to each note in a series.
+ * `currentSlug` marks the active part with `aria-current="page"` and drives the
+ * previous/next links.
+ */
+export declare function renderSeriesNavigation(index: SeriesIndex, currentSlug: string, options?: SeriesOptions): string;
+/**
+ * Renders a complete series as a standalone block, suitable for a landing page.
+ * Returns an empty string when the manifest has no member for `name`.
+ */
+export declare function renderSeriesIndex(manifest: ContentManifest, name: string, options?: SeriesOptions): string;
+/**
+ * Reports notes whose series metadata cannot be ordered reliably. Emitted
+ * diagnostics use `pluginName: "series"` and `severity: "warning"`.
+ */
+export declare function collectSeriesDiagnostics(manifest: ContentManifest, options?: SeriesOptions): Diagnostic[];

package/dist/src/types.d.ts

@@ -0,0 +1,43 @@
+/** Public options accepted by the `series()` plugin factory. */
+export type SeriesOptions = {
+    /** Frontmatter key that names the series. Defaults to `"series"`. */
+    key?: string;
+    /** Frontmatter key that holds the numeric order. Defaults to `"series_order"`. */
+    orderKey?: string;
+    /** Frontmatter key that overrides the displayed series title. Defaults to `"series_title"`. */
+    titleKey?: string;
+    /** Render the series heading above the part list. Defaults to `true`. */
+    heading?: boolean;
+    /** Base CSS class prefix. Defaults to `"rb-series"`. */
+    className?: string;
+    /** Render a `Part N of M` label for the current note. Defaults to `false`. */
+    positionLabel?: boolean;
+};
+/** Options after defaults have been applied. */
+export type ResolvedSeriesOptions = {
+    key: string;
+    orderKey: string;
+    titleKey: string;
+    heading: boolean;
+    className: string;
+    positionLabel: boolean;
+};
+/** A single note that belongs to a series. */
+export type SeriesMember = {
+    slug: string;
+    title: string;
+    permalink: string;
+    /** Numeric `orderKey` value, or `null` when it was missing or invalid. */
+    order: number | null;
+    /** The series name exactly as written in frontmatter. */
+    series: string;
+};
+/** An ordered series and all of its members. */
+export type SeriesIndex = {
+    /** Series name from frontmatter (used as the grouping key). */
+    name: string;
+    /** Display title: the first `titleKey` value, or `name` when absent. */
+    title: string;
+    /** Members sorted by `order`, then date, title, and slug. */
+    members: SeriesMember[];
+};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@riebeckite/plugin-series",
+  "version": "0.0.1",
+  "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.1"
+  },
+  "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/series"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Ordered multi-part post navigation for Riebeckite.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "series",
+    "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,91 @@
+.rb-series {
+  --rb-series-paper: var(--rb-color-paper, #ffffff);
+  --rb-series-ink: var(--rb-color-ink, #1a1a1a);
+  --rb-series-muted: var(--rb-color-muted, #69645c);
+  --rb-series-rule: var(
+    --rb-color-border,
+    color-mix(in srgb, var(--rb-series-ink) 16%, transparent)
+  );
+  --rb-series-accent: var(--rb-color-accent, #b4471f);
+  margin: 2rem 0;
+  padding: 1rem 1.25rem;
+  border: 1px solid var(--rb-series-rule);
+  background: color-mix(
+    in srgb,
+    var(--rb-series-paper) 97%,
+    var(--rb-series-ink)
+  );
+  color: var(--rb-series-ink);
+}
+
+.rb-series__title {
+  margin: 0 0 0.75rem;
+  font-size: 0.9375rem;
+  font-weight: 600;
+  letter-spacing: 0.02em;
+  text-transform: uppercase;
+}
+
+.rb-series__title a,
+.rb-series__list a {
+  color: inherit;
+  text-decoration: none;
+}
+
+.rb-series__title a:hover,
+.rb-series__list a:hover {
+  text-decoration: underline;
+}
+
+.rb-series__position {
+  margin-left: 0.5rem;
+  color: var(--rb-series-muted);
+  font-size: 0.75rem;
+  font-weight: 400;
+  letter-spacing: 0;
+  text-transform: none;
+}
+
+.rb-series__list {
+  margin: 0;
+  padding-left: 1.25rem;
+  color: var(--rb-series-ink);
+}
+
+.rb-series__item {
+  margin: 0.25rem 0;
+}
+
+.rb-series__item a[aria-current="page"] {
+  color: var(--rb-series-accent);
+  font-weight: 600;
+}
+
+.rb-series__nav {
+  display: flex;
+  gap: 1rem;
+  justify-content: space-between;
+  margin-top: 0.75rem;
+  padding-top: 0.75rem;
+  border-top: 1px solid var(--rb-series-rule);
+  font-size: 0.875rem;
+}
+
+.rb-series__prev,
+.rb-series__next {
+  color: var(--rb-series-accent);
+  text-decoration: none;
+}
+
+.rb-series__prev:hover,
+.rb-series__next:hover {
+  text-decoration: underline;
+}
+
+.rb-series--index {
+  margin: 2rem 0;
+}
+
+.rb-series--index .rb-series__title {
+  text-transform: none;
+}