@riebeckite/plugin-folder-pages 0.0.32 → 0.0.33

package/README.md

@@ -8,6 +8,10 @@ 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.
 
+## Live example
+
+The generated [folders](/folders) index is a Folder Page tree built from the site's folder structure.
+
 ## Installation
 
 ```bash

package/README_ja.md

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

package/dist/index.d.ts

@@ -5,4 +5,3 @@ 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

@@ -47,6 +47,7 @@ function collapseFolderEntryLocations(locations) {
   }
 }
 function buildFolderPages(manifest) {
+  const folderIcons = manifest.icons?.folders ?? {};
   const routableBySlug = /* @__PURE__ */ new Map();
   const routablePermalinks = /* @__PURE__ */ new Set();
   for (const entry of manifest.publicEntries) {
@@ -141,12 +142,16 @@ function buildFolderPages(manifest) {
   const isListed = (folder, language) => hasOwner(folder, language) || hasRoutablePage(folder, language) || isNavigable(folder, language) && generatedPath(folder, language) !== null;
   const folderLink = (folder, language) => {
     const owner = owners.get(languageKey(folder, language));
-    if (owner) return { title: owner.title, permalink: owner.permalink };
+    if (owner) return toLink(owner, folderIcons[folder]);
     const page = hasRoutablePage(folder, language) ? routableBySlug.get(folder) : void 0;
-    if (page) return { title: page.title, permalink: page.permalink };
+    if (page) return toLink(page, folderIcons[folder]);
     const pathname = generatedPath(folder, language);
     if (!pathname) return null;
-    return { title: lastSegment(folder), permalink: pathname };
+    return {
+      title: lastSegment(folder),
+      permalink: pathname,
+      ...folderIcons[folder] ? { icon: folderIcons[folder] } : {}
+    };
   };
   const sortedSubfolders = (folder, language) => {
     const subs = [...subfoldersFor(folder, language)].flatMap((sub) => {
@@ -178,7 +183,8 @@ function buildFolderPages(manifest) {
         pathname,
         language,
         title: lastSegment(folder),
-        pages: sortedPages(folder, language).map(toLink),
+        ...folderIcons[folder] ? { icon: folderIcons[folder] } : {},
+        pages: sortedPages(folder, language).map((entry) => toLink(entry)),
         folders: folderLinks.map((sub) => sub.link),
         dependencies: [
           { type: "folder", folder },
@@ -218,8 +224,13 @@ function sortedLanguages(languages) {
 function isEntryBasename(basename) {
   return ENTRY_BASENAMES.includes(basename);
 }
-function toLink(entry) {
-  return { title: entry.title, permalink: entry.permalink };
+function toLink(entry, fallbackIcon) {
+  const icon = entry.icon ?? fallbackIcon;
+  return {
+    title: entry.title,
+    permalink: entry.permalink,
+    ...icon ? { icon } : {}
+  };
 }
 function lastSegment(path) {
   const index = path.lastIndexOf("/");
@@ -277,7 +288,7 @@ 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>`
+    `<h1 class="${className}__title">${renderIcon(page.icon)}${escapeHtml(page.title)}</h1>`
   ];
   if (page.pages.length > 0) {
     parts.push(
@@ -299,7 +310,10 @@ function renderFolderPage(page, options) {
   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>`;
+  return `<li class="${className}__item"><a class="${className}__link" href="${escapeHtmlAttribute(link.permalink)}">${renderIcon(link.icon)}${escapeHtml(link.title)}</a></li>`;
+}
+function renderIcon(icon) {
+  return icon ? `<span class="rr-folder-page__icon">${icon.html}</span>` : "";
 }
 
 // index.ts
@@ -331,6 +345,7 @@ function folderPages(options = {}) {
           ...page.language === void 0 ? {} : { language: page.language }
         });
       }
+      models.delete(manifest);
     },
     pageTypes: [
       {
@@ -361,7 +376,6 @@ function folderPages(options = {}) {
     ]
   });
 }
-var folderPagesPlugin = folderPages;
 function validateFolderPagesOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -381,7 +395,6 @@ export {
   buildFolderPages,
   collapseFolderEntryLocations,
   folderPages,
-  folderPagesPlugin,
   renderFolderPage,
   resolveFolderPagesOptions
 };

package/dist/src/types.d.ts

@@ -1,4 +1,4 @@
-import type { OutputDependency } from "@riebeckite/core";
+import type { ContentIcon, OutputDependency } from "@riebeckite/core";
 export type FolderPagesOptions = {
     className?: string;
     pagesLabel?: string;
@@ -12,12 +12,14 @@ export type ResolvedFolderPagesOptions = {
 export type FolderPageLink = {
     title: string;
     permalink: string;
+    icon?: ContentIcon;
 };
 export type FolderPage = {
     folder: string;
     pathname: string;
     language?: string;
     title: string;
+    icon?: ContentIcon;
     pages: FolderPageLink[];
     folders: FolderPageLink[];
     dependencies: OutputDependency[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-folder-pages",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,12 +14,12 @@
     }
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.32"
+    "@riebeckite/core": "0.0.33"
   },
   "devDependencies": {
-    "tsx": "^4.22.4",
-    "@riebeckite/plugin-l10n": "0.0.32",
-    "@riebeckite/plugin-taxonomy": "0.0.32"
+    "@riebeckite/plugin-l10n": "0.0.33",
+    "@riebeckite/plugin-taxonomy": "0.0.33",
+    "tsx": "^4.22.4"
   },
   "publishConfig": {
     "access": "public"