quartz-community/folder-page
1
0
Fork 0
mirror of https://github.com/quartz-community/folder-page.git synced 2026-07-22 02:50:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
69 commits 1 branch 0 tags 437 KiB
TypeScript 98.1%
SCSS 1.9%
Find a file
saberzero1 d6debde1d8
docs: add missing defaultOptions and optionSchema to package.json manifest
2026-05-22 20:06:19 +02:00
.github/workflows build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:55 +02:00
dist build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:55 +02:00
src feat: wrap folder content in .markdown-preview-view and .markdown-rendered for Obsidian theme compat 2026-04-25 22:57:05 +02:00
test feat: exclude unlisted pages from folder discovery and listings 2026-04-11 13:50:43 +02:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 21:58:38 +01:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 18:36:01 +01:00
CHANGELOG.md feat: exclude unlisted pages from folder discovery and listings 2026-04-11 13:50:43 +02:00
LICENSE Initial commit 2026-02-13 18:36:01 +01:00
package-lock.json deps: update @quartz-community/utils 2026-04-22 18:17:48 +02:00
package.json docs: add missing defaultOptions and optionSchema to package.json manifest 2026-05-22 20:06:19 +02:00
README.md docs: add prefixFolders option to configuration table 2026-03-18 17:47:01 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json Initial commit 2026-02-13 18:36:01 +01:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:55 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

README.md

@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

npx quartz plugin add github:quartz-community/folder-page

Usage

plugins:
  - source: github:quartz-community/folder-page
    enabled: true

For advanced use cases, you can override in TypeScript:

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 for more information.

License

MIT