@riebeckite/plugin-taxonomy 0.0.16 → 0.0.17

package/README.md

@@ -141,10 +141,12 @@ the folder's landing 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.
+`taxonomy()` registers two page types. `taxonomy-term` renders one tag or
+folder page and includes feed discovery `<link rel="alternate">` metadata.
+`taxonomy-index` renders the all-tags list at `tagsBasePath` and the
+all-folders list at `foldersBasePath`, linking to every term. Both derive
+their SSG paths and resolver from the public manifest, so unpublished entries
+never appear on a tag, folder, or index page.
 
 Use `pluginPageSsgParams(content)` and `resolveRiebeckiteRoute(content, path)`
 from `@riebeckite/honox/server` in the site's generic catch-all route. This is
@@ -169,6 +171,7 @@ import "@riebeckite/plugin-taxonomy/style.css";
 - `buildTaxonomyIndex(entries, options)` — build tag and folder terms
 - `serializeTaxonomyIndex(index)` / `serializeTaxonomyTerm(term)` — JSON-safe projections
 - `renderTaxonomyPage(term, options)` / `renderRelatedTerms(term, options)` — page fragments
+- `renderTaxonomyIndexPage(kind, terms, options)` — all-tags/all-folders page fragment
 - `renderTermFeed(config, term, format, limit?)` / `buildFeedHeadTags(term)` — per-term feeds
 - `buildTaxonomySeo(config, term)` — listing-page SEO metadata
 - `slugifyTaxonomyValue(value)` — URL/file slug

package/README_ja.md

@@ -140,10 +140,12 @@ taxonomy はマニフェストの公開ビューからタグ語とフォルダ
 
 ## Page Type
 
-`taxonomy()` は `taxonomy-term` を登録します。SSG のパスと resolver は公開
-マニフェストから作るため、非公開エントリがタグ・フォルダページへ入ることはありません。
-返す page body にはフィード検出用の `<link rel="alternate">` メタデータを含め、
-共通の document frame が head に描画します。
+`taxonomy()` は 2 つの Page Type を登録します。`taxonomy-term` は 1 つのタグ・
+フォルダページを描画し、フィード検出用の `<link rel="alternate">` メタデータを
+含みます。`taxonomy-index` は `tagsBasePath` に全タグ一覧、`foldersBasePath` に
+全フォルダ一覧を描画し、各語へリンクします。どちらも SSG のパスと resolver を
+公開マニフェストから作るため、非公開エントリがタグ・フォルダ・一覧ページへ
+入ることはありません。
 
 サイトの共通 catch-all route では、`@riebeckite/honox/server` の
 `pluginPageSsgParams(content)` と `resolveRiebeckiteRoute(content, path)` を使います。
@@ -168,6 +170,7 @@ import "@riebeckite/plugin-taxonomy/style.css";
 - `buildTaxonomyIndex(entries, options)` — タグ・フォルダ語を構築する
 - `serializeTaxonomyIndex(index)` / `serializeTaxonomyTerm(term)` — JSON 安全な射影
 - `renderTaxonomyPage(term, options)` / `renderRelatedTerms(term, options)` — ページ断片
+- `renderTaxonomyIndexPage(kind, terms, options)` — 全タグ・全フォルダ一覧のページ断片
 - `renderTermFeed(config, term, format, limit?)` / `buildFeedHeadTags(term)` — 語ごとのフィード
 - `buildTaxonomySeo(config, term)` — 一覧ページの SEO メタデータ
 - `slugifyTaxonomyValue(value)` — URL・ファイル用の slug

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import type { ResolvedTaxonomyOptions, TaxonomyOptions } from "./src/types.js";
 export { buildTaxonomyIndex, serializeTaxonomyIndex, serializeTaxonomyTerm, toEntryReference, } from "./src/collections.js";
 export { buildFeedHeadTags, renderTermFeed } from "./src/feeds.js";
 export { DEFAULT_TAXONOMY_CLASS_NAME, DEFAULT_TAXONOMY_DATA_ENDPOINT, DEFAULT_TAXONOMY_FEED_LIMIT, DEFAULT_TAXONOMY_FOLDERS_BASE_PATH, DEFAULT_TAXONOMY_MIN_ENTRIES, DEFAULT_TAXONOMY_RELATED_LIMIT, DEFAULT_TAXONOMY_TAGS_BASE_PATH, resolveTaxonomyOptions, } from "./src/options.js";
-export { renderRelatedTerms, renderTaxonomyPage } from "./src/pages.js";
+export { renderRelatedTerms, renderTaxonomyIndexPage, renderTaxonomyPage, } from "./src/pages.js";
 export { buildTaxonomySeo } from "./src/seo.js";
 export { slugifyTaxonomyValue } from "./src/slug.js";
 export type { ResolvedTaxonomyOptions, TaxonomyEntryReference, TaxonomyFeedFormat, TaxonomyFeedLinks, TaxonomyFeedOptions, TaxonomyHeadTag, TaxonomyIndex, TaxonomyIndexData, TaxonomyKind, TaxonomyOptions, TaxonomyPage, TaxonomyRelatedTerm, TaxonomyTerm, TaxonomyTermContext, TaxonomyTermData, } from "./src/types.js";

package/dist/index.js

@@ -296,8 +296,8 @@ function renderJson(config, term, entries, title) {
 }
 function getResolvedFeedMetadata(config) {
   return {
-    description: config.site.feed.description ?? config.site.description,
-    language: config.site.feed.language ?? config.site.locale.replace("_", "-")
+    description: config.site.feed.description,
+    language: config.site.feed.language
   };
 }
 function getDescription(entry) {
@@ -421,6 +421,26 @@ function renderRelatedTerms(term, options) {
   ).join("");
   return `<nav class="${className}__related" aria-label="Related tags" data-rr-taxonomy-related><ul>${items}</ul></nav>`;
 }
+function renderTaxonomyIndexPage(kind, terms, options) {
+  const className = escapeHtmlAttribute(options.className);
+  const label = kind === "tag" ? "Tags" : "Folders";
+  const items = terms.map(
+    (term) => `<li class="${className}__item"><a class="${className}__link" href="${escapeHtmlAttribute(
+      term.path
+    )}" data-rr-taxonomy-count="${term.entries.length}">${escapeHtml(
+      term.title
+    )}</a></li>`
+  ).join("");
+  const html = `<section class="${className} ${className}--index" data-rr-taxonomy-index="${kind}"><h1 class="${className}__title">${escapeHtml(
+    label
+  )}</h1><ul class="${className}__list">${items}</ul></section>`;
+  return {
+    title: label,
+    frontmatter: { title: label },
+    html,
+    headTags: []
+  };
+}
 function renderFeedLinks(term, className) {
   const links = [];
   if (term.feeds.rss) {
@@ -506,6 +526,30 @@ function taxonomy(options = {}) {
             headTags: page.headTags
           };
         }
+      },
+      {
+        id: "taxonomy-index",
+        paths: () => taxonomyIndexPagePaths(resolved),
+        outputDependencies: [{ type: "global" }],
+        resolve: ({ manifest, pathname }) => {
+          const kind = resolveTaxonomyIndexPath(pathname, resolved);
+          if (!kind) return null;
+          const index = buildTaxonomyIndex(
+            manifest.discoverableEntries,
+            resolved
+          );
+          const page = renderTaxonomyIndexPage(
+            kind,
+            kind === "tag" ? index.tags : index.folders,
+            resolved
+          );
+          return {
+            type: "taxonomy-index",
+            pathname,
+            title: page.title,
+            body: page.html
+          };
+        }
       }
     ],
     buildEnd(context) {
@@ -539,6 +583,25 @@ function findTaxonomyTerm(entries, options, pathname) {
     (term) => term.path === pathname
   );
 }
+function taxonomyIndexPagePaths(options) {
+  const paths = [];
+  if (options.tags && options.tagsBasePath !== "") {
+    paths.push(options.tagsBasePath);
+  }
+  if (options.folders && options.foldersBasePath !== "") {
+    paths.push(options.foldersBasePath);
+  }
+  return [...new Set(paths)];
+}
+function resolveTaxonomyIndexPath(pathname, options) {
+  if (options.tags && options.tagsBasePath !== "" && pathname === options.tagsBasePath) {
+    return "tag";
+  }
+  if (options.folders && options.foldersBasePath !== "" && pathname === options.foldersBasePath) {
+    return "folder";
+  }
+  return null;
+}
 function resolveTaxonomyOptionsFromConfig(config) {
   const plugin = resolvePlugins2(config.plugins).find(
     (candidate) => candidate.name === TAXONOMY_PLUGIN_NAME
@@ -651,6 +714,7 @@ export {
   buildTaxonomyIndex,
   buildTaxonomySeo,
   renderRelatedTerms,
+  renderTaxonomyIndexPage,
   renderTaxonomyPage,
   renderTermFeed,
   resolveTaxonomyOptions,

package/dist/src/pages.d.ts

@@ -1,4 +1,4 @@
-import type { ResolvedTaxonomyOptions, TaxonomyPage, TaxonomyTerm } from "./types.js";
+import type { ResolvedTaxonomyOptions, TaxonomyKind, TaxonomyPage, TaxonomyTerm } from "./types.js";
 /**
  * Renders a taxonomy listing page fragment. The fragment owns the listing and
  * related-term navigation only; the Site's route and layout wrap it (see the
@@ -7,3 +7,4 @@ import type { ResolvedTaxonomyOptions, TaxonomyPage, TaxonomyTerm } from "./type
 export declare function renderTaxonomyPage(term: TaxonomyTerm, options: ResolvedTaxonomyOptions): TaxonomyPage;
 /** Renders only the related-term navigation for a tag term. */
 export declare function renderRelatedTerms(term: TaxonomyTerm, options: ResolvedTaxonomyOptions): string;
+export declare function renderTaxonomyIndexPage(kind: TaxonomyKind, terms: readonly TaxonomyTerm[], options: ResolvedTaxonomyOptions): TaxonomyPage;

package/package.json

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