@riebeckite/plugin-taxonomy 0.0.12 → 0.0.14

package/README.md

@@ -17,11 +17,10 @@ listing terms with the Core collection contract (`buildContentCollections`):
 Entries always link through their resolved `permalink`; the plugin never
 reconstructs a URL from a slug.
 
-The plugin owns data, feeds, and SEO only. It deliberately does **not** register
-application routes. Per-term feeds are written as static files through the
-build's generated-output sink, and an app renders `/tags/<tag>` and
-`/folders/<path>` from the exported helpers (see
-[App-route wiring](#app-route-wiring)).
+The plugin owns data, feeds, SEO, and the `/tags/<tag>` and `/folders/<path>`
+page types. Per-term feeds are written as static files through the build's
+generated-output sink. A site renders the page types through its generic
+Riebeckite catch-all route; no taxonomy-specific application route is needed.
 
 ## Usage
 
@@ -140,52 +139,16 @@ chosen permalink is recorded as `metadata["taxonomy.folder"]`. A location is
 never claimed when another note already owns it; the conflict is reported as a
 diagnostic instead.
 
-## App-route wiring
-
-The application owns routing. Register the listing paths in the app and render
-them from the plugin's data:
-
-```tsx
-// app/routes/tags/[slug{.+}].tsx
-import { ssgParams } from "hono/ssg";
-import { createRoute } from "honox/factory";
-import {
-  buildTaxonomyIndex,
-  buildTaxonomySeo,
-  renderTaxonomyPage,
-  resolveTaxonomyOptionsFromConfig,
-} from "@riebeckite/plugin-taxonomy";
-import Article from "../../components/article/article";
-import { config } from "../../config";
-import { content } from "../../content";
-
-export default createRoute(
-  ssgParams(async () => {
-    const options = resolveTaxonomyOptionsFromConfig(config);
-    const manifest = await content.getManifest();
-    return buildTaxonomyIndex(manifest.publicEntries, options).tags.map(
-      (term) => ({ slug: term.path.replace(/^\/tags\//, "") }),
-    );
-  }),
-  async (c) => {
-    const options = resolveTaxonomyOptionsFromConfig(config);
-    const manifest = await content.getManifest();
-    const term = buildTaxonomyIndex(manifest.publicEntries, options).tags.find(
-      (candidate) => candidate.path === c.req.path,
-    );
-    c.set("seo", term ? buildTaxonomySeo(config, term) : undefined);
-    if (!term) return c.notFound();
-    const page = renderTaxonomyPage(term, options);
-    c.set("headTags", page.headTags);
-    return c.render(<Article content={page} />);
-  },
-);
-```
+## Page types
+
+`taxonomy()` registers `taxonomy-term`. Its SSG paths and resolver are derived
+from the public manifest, so unpublished entries never appear in tag or folder
+pages. The returned page body includes feed discovery `<link rel="alternate">`
+metadata, which the generic document frame renders in its head.
 
-A folder route follows the same shape with `.folders` and `/folders/`. The
-`renderTaxonomyPage` result is `PostContent`-compatible (`frontmatter` + `html`),
-so it drops into the reference `Article` primitive; `headTags` adds the feed
-discovery `<link rel="alternate">` elements to the document head.
+Use `pluginPageSsgParams(content)` and `resolveRiebeckiteRoute(content, path)`
+from `@riebeckite/honox/server` in the site's generic catch-all route. This is
+the same wiring used for every plugin page type.
 
 ## Style
 
@@ -223,5 +186,5 @@ import "@riebeckite/plugin-taxonomy/style.css";
 
 ## See also
 
-- [Plugin guide](../../../docs/en/plugin-system.md)
-- [Content system](../../../docs/en/content-system.md)
+- [Plugin guide](../../../docs/en/reference/plugin-api.md)
+- [Content system](../../../docs/en/framework/content-system.md)

package/README_ja.md

@@ -17,11 +17,11 @@ Riebeckite のビルド時タクソノミー（タグ・フォルダ）プラグ
 エントリのリンクには常に解決済みの `permalink` を使い、slug から URL を組み立てる
 ことはありません。
 
-このプラグインが持つのはデータ・フィード・SEO だけです。アプリケーションの
-ルートは登録しません。語ごとのフィードはビルドの generated-output sink 経由で
-静的ファイルとして出力し、`/tags/<tag>` と `/folders/<path>` のページは
-エクスポートしたヘルパーを使ってアプリ側で描画します
-（[アプリルートの配線](#アプリルートの配線) を参照）。
+このプラグインはデータ・フィード・SEO に加え、`/tags/<tag>` と
+`/folders/<path>` の Page Type を提供します。語ごとのフィードは build の
+generated-output sink 経由で静的ファイルとして出力します。サイトは共通の
+Riebeckite catch-all route で Page Type を描画するため、taxonomy 専用の
+アプリケーションルートは不要です。
 
 ## 使い方
 
@@ -137,52 +137,16 @@ Core `seo` 拡張ポイント（たとえば `@riebeckite/plugin-seo`）へ委
 選ばれた permalink は `metadata["taxonomy.folder"]` に記録されます。すでに他の
 ノートが所有している location は決して奪わず、衝突は診断として報告します。
 
-## アプリルートの配線
-
-ルーティングはアプリケーションが所有します。一覧パスをアプリに登録し、プラグインの
-データから描画してください。
-
-```tsx
-// app/routes/tags/[slug{.+}].tsx
-import { ssgParams } from "hono/ssg";
-import { createRoute } from "honox/factory";
-import {
-  buildTaxonomyIndex,
-  buildTaxonomySeo,
-  renderTaxonomyPage,
-  resolveTaxonomyOptionsFromConfig,
-} from "@riebeckite/plugin-taxonomy";
-import Article from "../../components/article/article";
-import { config } from "../../config";
-import { content } from "../../content";
-
-export default createRoute(
-  ssgParams(async () => {
-    const options = resolveTaxonomyOptionsFromConfig(config);
-    const manifest = await content.getManifest();
-    return buildTaxonomyIndex(manifest.publicEntries, options).tags.map(
-      (term) => ({ slug: term.path.replace(/^\/tags\//, "") }),
-    );
-  }),
-  async (c) => {
-    const options = resolveTaxonomyOptionsFromConfig(config);
-    const manifest = await content.getManifest();
-    const term = buildTaxonomyIndex(manifest.publicEntries, options).tags.find(
-      (candidate) => candidate.path === c.req.path,
-    );
-    c.set("seo", term ? buildTaxonomySeo(config, term) : undefined);
-    if (!term) return c.notFound();
-    const page = renderTaxonomyPage(term, options);
-    c.set("headTags", page.headTags);
-    return c.render(<Article content={page} />);
-  },
-);
-```
+## Page Type
+
+`taxonomy()` は `taxonomy-term` を登録します。SSG のパスと resolver は公開
+マニフェストから作るため、非公開エントリがタグ・フォルダページへ入ることはありません。
+返す page body にはフィード検出用の `<link rel="alternate">` メタデータを含め、
+共通の document frame が head に描画します。
 
-フォルダのルートも `.folders` と `/folders/` に置き換えると同じ形です。
-`renderTaxonomyPage` の戻り値は `PostContent` 互換（`frontmatter` + `html`）なので、
-参照アプリの `Article` primitive にそのまま渡せます。`headTags` はフィード検出用の
-`<link rel="alternate">` を document head に追加します。
+サイトの共通 catch-all route では、`@riebeckite/honox/server` の
+`pluginPageSsgParams(content)` と `resolveRiebeckiteRoute(content, path)` を使います。
+これはすべての Plugin Page Type に共通の配線です。
 
 ## スタイル
 
@@ -221,5 +185,5 @@ import "@riebeckite/plugin-taxonomy/style.css";
 
 ## 関連
 
-- [プラグインガイド](../../../docs/ja/plugin-system.md)
-- [コンテンツシステム](../../../docs/ja/content-system.md)
+- [プラグインガイド](../../../docs/ja/reference/plugin-api.md)
+- [コンテンツシステム](../../../docs/ja/framework/content-system.md)

package/dist/index.d.ts

@@ -14,11 +14,10 @@ export declare const TAXONOMY_PLUGIN_NAME = "taxonomy";
  * Build-time taxonomy data, per-term feeds, SEO metadata, and folder-index
  * locations for Riebeckite.
  *
- * The plugin owns data, feeds, and SEO only. It does not register application
- * routes: an app renders `/tags/<tag>` and `/folders/<path>` from the exported
- * helpers (see the README for the documented wiring). Per-term feeds are
- * emitted as static files through the build's generated-output sink, so no
- * client JavaScript is required.
+ * The plugin owns data, feeds, SEO, and tag/folder page types. A generic site
+ * catch-all resolves those page types, so this plugin never needs application
+ * routes. Per-term feeds are emitted as static files through the build's
+ * generated-output sink, so no client JavaScript is required.
  */
 export declare function taxonomy(options?: TaxonomyOptions): import("@riebeckite/core").RiebeckitePlugin<TaxonomyOptions>;
 /** Alias matching the `*Plugin` suffix used by other plugin factories. */

package/dist/index.js

@@ -529,6 +529,28 @@ function taxonomy(options = {}) {
     validateOptions: validateTaxonomyOptions,
     resolveContentLocations: ({ entries, diagnostics }) => resolveFolderIndexLocations(entries, resolved, diagnostics),
     endpoints: createTaxonomyEndpoints(resolved),
+    pageTypes: [
+      {
+        id: "taxonomy-term",
+        paths: ({ manifest }) => taxonomyPagePaths(manifest.publicEntries, resolved),
+        resolve: ({ manifest, pathname }) => {
+          const term = findTaxonomyTerm(
+            manifest.publicEntries,
+            resolved,
+            pathname
+          );
+          if (!term) return null;
+          const page = renderTaxonomyPage(term, resolved);
+          return {
+            type: "taxonomy-term",
+            pathname: term.path,
+            title: page.title,
+            body: page.html,
+            headTags: page.headTags
+          };
+        }
+      }
+    ],
     buildEnd(context) {
       const { config, manifest } = context;
       if (!config) return;
@@ -549,6 +571,16 @@ function taxonomy(options = {}) {
   });
 }
 var taxonomyPlugin = taxonomy;
+function taxonomyPagePaths(entries, options) {
+  const index = buildTaxonomyIndex(entries, options);
+  return [...index.tags, ...index.folders].map((term) => term.path);
+}
+function findTaxonomyTerm(entries, options, pathname) {
+  const index = buildTaxonomyIndex(entries, options);
+  return [...index.tags, ...index.folders].find(
+    (term) => term.path === pathname
+  );
+}
 function resolveTaxonomyOptionsFromConfig(config) {
   const plugin = resolvePlugins2(config.plugins).find(
     (candidate) => candidate.name === TAXONOMY_PLUGIN_NAME

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-taxonomy",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,7 +15,7 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.12"
+    "@riebeckite/core": "0.0.14"
   },
   "devDependencies": {
     "tsx": "^4.22.4"