@riebeckite/plugin-series 0.0.20 → 0.0.22

package/README.md

@@ -1,5 +1,7 @@
 # @riebeckite/plugin-series
 
+<!-- Generated from docs/docs/plugins/series.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
 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.
@@ -65,32 +67,9 @@ the numbered parts, using `date`/`created`/`published`, then `title`, then
 | `positionLabel` | `boolean` | `false` | Add a `Part N of M` label for the current note. |
 | `basePath` | `string` | `"/series"` | Base path for the generated pages. An empty string disables them. |
 
-## 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>
-```
+## Display
+
+Each note in a series of two or more parts receives live series navigation after its article. The links and current position are calculated from the frontmatter shown above.
 
 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,
@@ -171,5 +150,4 @@ matched with `.rb-series__item a[aria-current="page"]`.
 
 ## See also
 
-- [Plugin guide](../../../docs/docs/reference/plugin-api.md)
-
+- [Plugin guide](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.md)

package/README_ja.md

@@ -1,5 +1,7 @@
 # @riebeckite/plugin-series
 
+<!-- Generated from docs/docs/plugins/series.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
 連載記事（シリーズ）を順番どおりに並べ、各記事へ共通のナビゲーションを差し込むプラグインです。ビルド時に、同じシリーズ名を持つノートをまとめて、目次・現在位置・前後の記事リンクを生成します。
 
 [English](./README.md)
@@ -54,31 +56,9 @@ series_order: 2
 | `positionLabel` | `boolean` | `false` | 現在の記事に「Part N of M」を付ける。 |
 | `basePath` | `string` | `"/series"` | 生成するページの基準パス。空文字にすると生成しない。 |
 
-## 出力
-
-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>
-```
+## 表示
+
+2 件以上あるシリーズの各ノートには、記事の下にシリーズナビゲーションが実際に描画されます。リンクと現在位置は、上の frontmatter から計算します。
 
 テキストと属性はすべてエスケープします。生成した HTML は manifest の entry と処理済みコンテンツの両方へ書き戻すため、ページのルート表示・フィード・検索でも同じマークアップになります。
 
@@ -144,5 +124,4 @@ const html = renderSeriesIndex(manifest, "何かを作る");
 
 ## 関連
 
-- [プラグインガイド](../../../docs/docs/reference/plugin-api.ja.md)
-
+- [プラグインガイド](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.ja.md)

package/package.json

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