@riebeckite/plugin-folder-pages 0.0.0-stage → 0.0.16

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

@@ -1,3 +1,73 @@
-# Temporary Holding Version
+# @riebeckite/plugin-folder-pages
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[日本語](./README_ja.md)
+
+Folder Page support for Riebeckite. The plugin turns folder entry notes into the
+folder's landing page and generates a listing page for folders that have no
+entry note.
+
+## Installation
+
+```bash
+pnpm add @riebeckite/plugin-folder-pages
+```
+
+## Usage
+
+```ts
+import { folderPages } from "@riebeckite/plugin-folder-pages";
+
+export default {
+  plugins: [folderPages()],
+};
+```
+
+## Markdown-backed Folder Pages
+
+A note at `<folder>/README.md` or `<folder>/index.md` becomes the folder's
+landing page. Its resolved permalink is collapsed from `/folder/README` or
+`/folder/index` to `/folder/`, and the old URL redirects to the new one.
+
+The collapse never guesses a URL from the slug. It rewrites the permalink that
+the location resolver already produced, so localized and custom permalinks stay
+correct.
+
+Only `README` and `index` are treated as folder entries. A note at
+`<folder>.md` stays a normal content page.
+
+When a folder contains both `README.md` and `index.md`, neither is collapsed:
+the choice would be ambiguous, so the plugin leaves both notes at their default
+locations.
+
+## Generated Folder Pages
+
+Folders without a markdown entry note but with discoverable content get an
+automatically generated page at `/folder/`. The page lists only the folder's
+direct children:
+
+- **Pages**: direct public, discoverable notes.
+- **Folders**: direct subfolders that contain discoverable content.
+
+The listing is built from `manifest.discoverableEntries`, so unlisted, draft,
+and scheduled notes never appear. Notes reachable only by URL stay hidden from
+the navigation. The `folder.md` case is never confused with a folder entry.
+
+## Ordering
+
+Pages and folders are sorted by their resolved permalink, then by title, so the
+output is deterministic regardless of plugin order.
+
+## Options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `className` | `string` | `"rr-folder-page"` | Root CSS class for the rendered fragment. |
+| `pagesLabel` | `string` | `"Pages"` | Heading for the page list. |
+| `foldersLabel` | `string` | `"Folders"` | Heading for the folder list. |
+
+## Plugin dependencies
+
+The plugin declares an optional dependency on the `content.localization`
+capability. When `@riebeckite/plugin-l10n` is enabled, the folder page location
+rewrite runs after localization so the collapsed URLs and redirects use the
+final, localized permalinks. Without l10n, the plugin still works on its own.

package/README_ja.md

@@ -0,0 +1,73 @@
+# @riebeckite/plugin-folder-pages
+
+[English](./README.md)
+
+Riebeckite の Folder Page を提供するプラグインです。フォルダの入口ノートを
+フォルダのランディングページにし、入口ノートのないフォルダには一覧ページを
+自動生成します。
+
+## インストール
+
+```bash
+pnpm add @riebeckite/plugin-folder-pages
+```
+
+## 使い方
+
+```ts
+import { folderPages } from "@riebeckite/plugin-folder-pages";
+
+export default {
+  plugins: [folderPages()],
+};
+```
+
+## Markdown ベースの Folder Page
+
+`<folder>/README.md` または `<folder>/index.md` にあるノートは、そのフォルダの
+ランディングページになります。解決済みの permalink を `/folder/README` や
+`/folder/index` から `/folder/` へ畳み込み、元の URL から新しい URL へ
+リダイレクトします。
+
+畳み込みは slug から URL を推測しません。ロケーションリゾルバが確定させた
+permalink を書き換えるため、l10n やカスタム permalink でも正しい URL を
+維持します。
+
+フォルダ入口として扱うのは `README` と `index` だけです。`<folder>.md` は
+通常のコンテンツページのままです。
+
+同じフォルダに `README.md` と `index.md` の両方がある場合は、どちらも
+畳み込みません。暗黙に一方を選ぶと曖昧になるためです。
+
+## 自動生成される Folder Page
+
+入口ノートを持たず、公開されたコンテンツがあるフォルダには `/folder/` に
+ページを自動生成します。表示するのはフォルダ直下の要素だけです。
+
+- **Pages**: 直下の公開・discoverable なノート
+- **Folders**: discoverable なコンテンツを持つ直下のサブフォルダ
+
+一覧は `manifest.discoverableEntries` を基準に作るため、unlisted・draft・
+scheduled のノートは表示されません。URL を知っていれば到達できるノートと、
+自動ナビゲーションから発見できるノートを区別します。`folder.md` を
+フォルダ入口と混同することもありません。
+
+## 並び順
+
+Pages と Folders は解決済み permalink、次に title で並べます。プラグインの
+順序に依存せず、出力は常に決定的です。
+
+## オプション
+
+| オプション | 型 | 既定値 | 説明 |
+| --- | --- | --- | --- |
+| `className` | `string` | `"rr-folder-page"` | 生成するフラグメントのルート CSS クラス。 |
+| `pagesLabel` | `string` | `"Pages"` | ページ一覧の見出し。 |
+| `foldersLabel` | `string` | `"Folders"` | フォルダ一覧の見出し。 |
+
+## プラグイン依存
+
+`content.localization` capability への任意依存を宣言しています。
+`@riebeckite/plugin-l10n` を有効にすると、フォルダページのロケーション
+書き換えがローカライズの後に実行され、畳み込み後の URL とリダイレクトが
+最終的なローカライズ済み permalink を使います。l10n なしでも単独で動作します。

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import type { FolderPagesOptions } from "./src/types.js";
+export { buildFolderPages, collapseFolderEntryLocations, } from "./src/folder_pages.js";
+export { DEFAULT_FOLDER_PAGES_CLASS_NAME, DEFAULT_FOLDER_PAGES_FOLDERS_LABEL, DEFAULT_FOLDER_PAGES_PAGES_LABEL, resolveFolderPagesOptions, } from "./src/options.js";
+export { renderFolderPage } from "./src/pages.js";
+export type { FolderPage, FolderPageLink, FolderPagesModel, FolderPagesOptions, ResolvedFolderPagesOptions, } from "./src/types.js";
+export declare const FOLDER_PAGES_PLUGIN_NAME = "folder-pages";
+export declare function folderPages(options?: FolderPagesOptions): import("@riebeckite/core").RiebeckitePlugin<FolderPagesOptions>;
+export declare const folderPagesPlugin: typeof folderPages;

package/dist/index.js

@@ -0,0 +1,325 @@
+// index.ts
+import {
+  definePlugin
+} from "@riebeckite/core";
+
+// src/folder_pages.ts
+import { resolveGeneratedFolderLocation } from "@riebeckite/core";
+var ENTRY_BASENAMES = ["README", "index"];
+function collapseFolderEntryLocations(locations) {
+  const owners = /* @__PURE__ */ new Map();
+  for (const location of locations.values()) {
+    if (!owners.has(location.permalink)) {
+      owners.set(location.permalink, location.slug);
+    }
+  }
+  const byFolder = /* @__PURE__ */ new Map();
+  for (const slug of locations.keys()) {
+    const basename = lastSegment(slug);
+    if (!isEntryBasename(basename)) continue;
+    const folder = parentFolder(slug);
+    const slugs = byFolder.get(folder);
+    if (slugs) slugs.push(slug);
+    else byFolder.set(folder, [slug]);
+  }
+  for (const slugs of byFolder.values()) {
+    if (slugs.length !== 1) continue;
+    const slug = slugs[0];
+    const location = locations.get(slug);
+    if (!location) continue;
+    const basename = lastSegment(slug);
+    if (!location.permalink.endsWith(`/${basename}`)) continue;
+    const target = location.permalink.slice(
+      0,
+      location.permalink.length - basename.length
+    );
+    if (!target.endsWith("/")) continue;
+    const owner = owners.get(target);
+    if (owner !== void 0 && owner !== slug) continue;
+    const redirects = [
+      ...location.redirects ?? [],
+      { path: location.permalink, status: 301 }
+    ];
+    locations.set(slug, { ...location, permalink: target, redirects });
+    owners.delete(location.permalink);
+    owners.set(target, slug);
+  }
+}
+function buildFolderPages(manifest) {
+  const pagesByFolder = /* @__PURE__ */ new Map();
+  const subfoldersOf = /* @__PURE__ */ new Map();
+  const allFolders = /* @__PURE__ */ new Set();
+  const routableBySlug = /* @__PURE__ */ new Map();
+  const routablePermalinks = /* @__PURE__ */ new Set();
+  for (const entry of manifest.publicEntries) {
+    routableBySlug.set(entry.slug, entry);
+    routablePermalinks.add(stripTrailingSlash(entry.permalink));
+  }
+  const addSubfolder = (parent, child) => {
+    const subs = subfoldersOf.get(parent);
+    if (subs) subs.add(child);
+    else subfoldersOf.set(parent, /* @__PURE__ */ new Set([child]));
+    allFolders.add(parent);
+    allFolders.add(child);
+  };
+  for (const entry of manifest.discoverableEntries) {
+    const slug = entry.slug;
+    const basename = lastSegment(slug);
+    const parent = parentFolder(slug);
+    allFolders.add(parent);
+    if (!isEntryBasename(basename)) {
+      const pages2 = pagesByFolder.get(parent);
+      if (pages2) pages2.push(entry);
+      else pagesByFolder.set(parent, [entry]);
+    }
+    let child = parent;
+    while (child !== "") {
+      const grandparent = parentFolder(child);
+      addSubfolder(grandparent, child);
+      child = grandparent;
+    }
+  }
+  const hasRoutableOwner = (folder) => routableBySlug.has(`${folder}/README`) || routableBySlug.has(`${folder}/index`);
+  const hasRoutablePage = (folder) => routableBySlug.has(folder);
+  const sortedPages = (folder) => {
+    const subfolders = subfoldersOf.get(folder);
+    const pages2 = (pagesByFolder.get(folder) ?? []).filter(
+      (entry) => !subfolders?.has(entry.slug)
+    );
+    pages2.sort(compareEntries);
+    return pages2;
+  };
+  const navigableCache = /* @__PURE__ */ new Map();
+  const isNavigable = (folder) => {
+    const cached = navigableCache.get(folder);
+    if (cached !== void 0) return cached;
+    navigableCache.set(folder, false);
+    let result = sortedPages(folder).length > 0 || hasRoutableOwner(folder) || hasRoutablePage(folder);
+    if (!result) {
+      for (const sub of subfoldersOf.get(folder) ?? []) {
+        if (isListed(sub)) {
+          result = true;
+          break;
+        }
+      }
+    }
+    navigableCache.set(folder, result);
+    return result;
+  };
+  const isListed = (folder) => hasRoutableOwner(folder) || hasRoutablePage(folder) || isNavigable(folder) && generatedPath(folder) !== null;
+  const generatedPath = (folder) => resolveGeneratedFolderLocation(manifest, folder);
+  const folderLink = (folder) => {
+    if (hasRoutableOwner(folder)) {
+      const owner = routableBySlug.get(`${folder}/README`) ?? routableBySlug.get(`${folder}/index`);
+      if (owner) return { title: owner.title, permalink: owner.permalink };
+    }
+    const page = routableBySlug.get(folder);
+    if (page) return { title: page.title, permalink: page.permalink };
+    const pathname = generatedPath(folder);
+    if (!pathname) return null;
+    return { title: lastSegment(folder), permalink: pathname };
+  };
+  const sortedSubfolders = (folder) => {
+    const subs = [...subfoldersOf.get(folder) ?? []].flatMap((sub) => {
+      if (!isListed(sub)) return [];
+      const link = folderLink(sub);
+      return link ? [{ folder: sub, link }] : [];
+    });
+    subs.sort((a, b) => compareLinks(a.link, b.link));
+    return subs;
+  };
+  const folders = [...allFolders].filter((folder) => folder !== "");
+  folders.sort(compareStrings);
+  const pages = [];
+  const takenPaths = /* @__PURE__ */ new Set();
+  for (const folder of folders) {
+    if (!isNavigable(folder)) continue;
+    if (hasRoutableOwner(folder)) continue;
+    if (hasRoutablePage(folder)) continue;
+    const pathname = generatedPath(folder);
+    if (!pathname) continue;
+    if (pathname === "/") continue;
+    if (routablePermalinks.has(stripTrailingSlash(pathname))) continue;
+    if (takenPaths.has(pathname)) continue;
+    takenPaths.add(pathname);
+    const folders_ = sortedSubfolders(folder);
+    pages.push({
+      folder,
+      pathname,
+      title: lastSegment(folder),
+      pages: sortedPages(folder).map(toLink),
+      folders: folders_.map((sub) => sub.link),
+      dependencies: [
+        { type: "folder", folder },
+        ...folders_.map((sub) => ({
+          type: "folder",
+          folder: sub.folder
+        }))
+      ]
+    });
+  }
+  pages.sort((a, b) => compareStrings(a.pathname, b.pathname));
+  const byPath = /* @__PURE__ */ new Map();
+  for (const page of pages) byPath.set(page.pathname, page);
+  return { paths: pages.map((page) => page.pathname), byPath };
+}
+function isEntryBasename(basename) {
+  return ENTRY_BASENAMES.includes(basename);
+}
+function toLink(entry) {
+  return { title: entry.title, permalink: entry.permalink };
+}
+function lastSegment(path) {
+  const index = path.lastIndexOf("/");
+  return index === -1 ? path : path.slice(index + 1);
+}
+function parentFolder(path) {
+  const index = path.lastIndexOf("/");
+  return index === -1 ? "" : path.slice(0, index);
+}
+function stripTrailingSlash(url) {
+  if (url.length > 1 && url.endsWith("/")) return url.slice(0, -1);
+  return url;
+}
+function compareEntries(a, b) {
+  return compareStrings(a.permalink, b.permalink) || compareStrings(a.title, b.title) || compareStrings(a.slug, b.slug);
+}
+function compareLinks(a, b) {
+  return compareStrings(a.permalink, b.permalink) || compareStrings(a.title, b.title);
+}
+function compareStrings(a, b) {
+  if (a < b) return -1;
+  if (a > b) return 1;
+  return 0;
+}
+
+// src/options.ts
+var DEFAULT_FOLDER_PAGES_CLASS_NAME = "rr-folder-page";
+var DEFAULT_FOLDER_PAGES_PAGES_LABEL = "Pages";
+var DEFAULT_FOLDER_PAGES_FOLDERS_LABEL = "Folders";
+function resolveFolderPagesOptions(options = {}) {
+  return {
+    className: normalizeString(
+      options.className,
+      DEFAULT_FOLDER_PAGES_CLASS_NAME
+    ),
+    pagesLabel: normalizeString(
+      options.pagesLabel,
+      DEFAULT_FOLDER_PAGES_PAGES_LABEL
+    ),
+    foldersLabel: normalizeString(
+      options.foldersLabel,
+      DEFAULT_FOLDER_PAGES_FOLDERS_LABEL
+    )
+  };
+}
+function normalizeString(value, fallback) {
+  if (typeof value !== "string") return fallback;
+  const trimmed = value.trim();
+  return trimmed === "" ? fallback : trimmed;
+}
+
+// src/pages.ts
+import { escapeHtml, escapeHtmlAttribute } from "@riebeckite/core";
+function renderFolderPage(page, options) {
+  const className = escapeHtmlAttribute(options.className);
+  const parts = [
+    `<section class="${className}" data-rr-folder-page="${escapeHtmlAttribute(page.folder)}">`,
+    `<h1 class="${className}__title">${escapeHtml(page.title)}</h1>`
+  ];
+  if (page.pages.length > 0) {
+    parts.push(
+      `<h2 class="${className}__heading">${escapeHtml(options.pagesLabel)}</h2>`,
+      `<ul class="${className}__pages">`
+    );
+    for (const link of page.pages) parts.push(renderLink(className, link));
+    parts.push("</ul>");
+  }
+  if (page.folders.length > 0) {
+    parts.push(
+      `<h2 class="${className}__heading">${escapeHtml(options.foldersLabel)}</h2>`,
+      `<ul class="${className}__folders">`
+    );
+    for (const link of page.folders) parts.push(renderLink(className, link));
+    parts.push("</ul>");
+  }
+  parts.push("</section>");
+  return { title: page.title, html: parts.join("") };
+}
+function renderLink(className, link) {
+  return `<li class="${className}__item"><a class="${className}__link" href="${escapeHtmlAttribute(link.permalink)}">${escapeHtml(link.title)}</a></li>`;
+}
+
+// index.ts
+var FOLDER_PAGES_PLUGIN_NAME = "folder-pages";
+function folderPages(options = {}) {
+  const resolved = resolveFolderPagesOptions(options);
+  const models = /* @__PURE__ */ new WeakMap();
+  const modelFor = (manifest) => {
+    const cached = models.get(manifest);
+    if (cached) return cached;
+    const model = buildFolderPages(manifest);
+    models.set(manifest, model);
+    return model;
+  };
+  return definePlugin({
+    name: FOLDER_PAGES_PLUGIN_NAME,
+    provides: ["content.folder-pages"],
+    options,
+    optional: ["content.localization"],
+    validateOptions: validateFolderPagesOptions,
+    extendContentLocations: ({ locations }) => {
+      collapseFolderEntryLocations(locations);
+    },
+    onManifestCreated: ({ manifest }) => {
+      for (const page of modelFor(manifest).byPath.values()) {
+        manifest.folderLocations.set(page.folder, { pathname: page.pathname });
+      }
+    },
+    pageTypes: [
+      {
+        id: "folder-page",
+        directoryIndex: true,
+        paths: ({ manifest }) => modelFor(manifest).paths,
+        outputDependencies: ({ manifest, pathname }) => modelFor(manifest).byPath.get(pathname)?.dependencies ?? [
+          { type: "unknown" }
+        ],
+        resolve: ({ manifest, pathname }) => {
+          const page = modelFor(manifest).byPath.get(pathname);
+          if (!page) return null;
+          const rendered = renderFolderPage(page, resolved);
+          return {
+            type: "folder-page",
+            pathname: page.pathname,
+            title: rendered.title,
+            body: rendered.html
+          };
+        }
+      }
+    ]
+  });
+}
+var folderPagesPlugin = folderPages;
+function validateFolderPagesOptions(options) {
+  if (!options) return [];
+  const issues = [];
+  for (const key of ["className", "pagesLabel", "foldersLabel"]) {
+    const value = options[key];
+    if (value !== void 0 && (typeof value !== "string" || value.trim() === "")) {
+      issues.push({ path: key, message: "Expected a non-empty string." });
+    }
+  }
+  return issues;
+}
+export {
+  DEFAULT_FOLDER_PAGES_CLASS_NAME,
+  DEFAULT_FOLDER_PAGES_FOLDERS_LABEL,
+  DEFAULT_FOLDER_PAGES_PAGES_LABEL,
+  FOLDER_PAGES_PLUGIN_NAME,
+  buildFolderPages,
+  collapseFolderEntryLocations,
+  folderPages,
+  folderPagesPlugin,
+  renderFolderPage,
+  resolveFolderPagesOptions
+};

package/dist/src/folder_pages.d.ts

@@ -0,0 +1,4 @@
+import type { ContentManifest, ContentPublicLocation } from "@riebeckite/core";
+import type { FolderPagesModel } from "./types.js";
+export declare function collapseFolderEntryLocations(locations: Map<string, ContentPublicLocation>): void;
+export declare function buildFolderPages(manifest: ContentManifest): FolderPagesModel;

package/dist/src/options.d.ts

@@ -0,0 +1,5 @@
+import type { FolderPagesOptions, ResolvedFolderPagesOptions } from "./types.js";
+export declare const DEFAULT_FOLDER_PAGES_CLASS_NAME = "rr-folder-page";
+export declare const DEFAULT_FOLDER_PAGES_PAGES_LABEL = "Pages";
+export declare const DEFAULT_FOLDER_PAGES_FOLDERS_LABEL = "Folders";
+export declare function resolveFolderPagesOptions(options?: FolderPagesOptions): ResolvedFolderPagesOptions;

package/dist/src/pages.d.ts

@@ -0,0 +1,5 @@
+import type { FolderPage, ResolvedFolderPagesOptions } from "./types.js";
+export declare function renderFolderPage(page: FolderPage, options: ResolvedFolderPagesOptions): {
+    title: string;
+    html: string;
+};

package/dist/src/types.d.ts

@@ -0,0 +1,27 @@
+import type { OutputDependency } from "@riebeckite/core";
+export type FolderPagesOptions = {
+    className?: string;
+    pagesLabel?: string;
+    foldersLabel?: string;
+};
+export type ResolvedFolderPagesOptions = {
+    className: string;
+    pagesLabel: string;
+    foldersLabel: string;
+};
+export type FolderPageLink = {
+    title: string;
+    permalink: string;
+};
+export type FolderPage = {
+    folder: string;
+    pathname: string;
+    title: string;
+    pages: FolderPageLink[];
+    folders: FolderPageLink[];
+    dependencies: OutputDependency[];
+};
+export type FolderPagesModel = {
+    paths: string[];
+    byPath: Map<string, FolderPage>;
+};

package/package.json

@@ -1,6 +1,57 @@
 {
   "name": "@riebeckite/plugin-folder-pages",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.16",
+  "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"
+    }
+  },
+  "dependencies": {
+    "@riebeckite/core": "0.0.16"
+  },
+  "devDependencies": {
+    "tsx": "^4.22.4",
+    "@riebeckite/plugin-l10n": "0.0.16",
+    "@riebeckite/plugin-taxonomy": "0.0.16"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/folder-pages"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Folder entry pages and generated folder listings for Riebeckite.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "folder",
+    "navigation"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
+  }
 }