@quartz-community/folder-page 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Respect the `file.data.unlisted` convention in both folder discovery (virtual page generation) and folder listings (the page-list inside a folder index). Unlisted pages are never shown in folder listings and never contribute folder/subfolder entries.
+- Exported `pagesFromAllFiles` helper for reuse and testing.
+- Unit tests for `pagesFromAllFiles` covering the unlisted-filter behavior.
+
+- Initial Quartz community plugin template.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Quartz Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+# @quartz-community/folder-page
+
+Renders folder index pages showing a listing of all pages within that folder. Automatically generates virtual index pages for folders that don't have one.
+
+## Installation
+
+```bash
+npx quartz plugin add github:quartz-community/folder-page
+```
+
+## Usage
+
+```yaml title="quartz.config.yaml"
+plugins:
+  - source: github:quartz-community/folder-page
+    enabled: true
+```
+
+For advanced use cases, you can override in TypeScript:
+
+```ts title="quartz.ts (override)"
+import * as ExternalPlugin from "./.quartz/plugins";
+
+ExternalPlugin.FolderPage({
+  showFolderCount: true,
+  showSubfolders: true,
+  prefixFolders: false,
+});
+```
+
+## Configuration
+
+| Option            | Type      | Default     | Description                                                                            |
+| ----------------- | --------- | ----------- | -------------------------------------------------------------------------------------- |
+| `showFolderCount` | `boolean` | `undefined` | Whether to show the number of items in the folder.                                     |
+| `showSubfolders`  | `boolean` | `undefined` | Whether to show subfolders in the listing.                                             |
+| `sort`            | `SortFn`  | `undefined` | A function to sort the pages in the folder.                                            |
+| `prefixFolders`   | `boolean` | `false`     | Whether to prefix generated folder page titles with "Folder: " (e.g. "Folder: notes"). |
+
+## Documentation
+
+See the [Quartz documentation](https://quartz.jzhao.xyz/plugins/FolderPage) for more information.
+
+## License
+
+MIT

package/dist/FolderContent-DEXAgZWS.d.ts

@@ -0,0 +1,10 @@
+import { SortFn, QuartzComponent } from '@quartz-community/types';
+
+interface FolderContentOptions {
+    showFolderCount: boolean;
+    showSubfolders: boolean;
+    sort?: SortFn;
+}
+declare const _default: (opts?: Partial<FolderContentOptions>) => QuartzComponent;
+
+export { _default as _ };

package/dist/components/index.d.ts

@@ -0,0 +1,9 @@
+export { _ as FolderContent } from '../FolderContent-DEXAgZWS.js';
+import { QuartzComponent, SortFn } from '@quartz-community/types';
+export { SortFn } from '@quartz-community/types';
+export { byDateAndAlphabetical } from '@quartz-community/utils/sort';
+
+declare function byDateAndAlphabeticalFolderFirst(_cfg: unknown): SortFn;
+declare const PageList: QuartzComponent;
+
+export { PageList, byDateAndAlphabeticalFolderFirst };