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
17 commits 1 branch 0 tags 437 KiB
TypeScript 98.1%
SCSS 1.9%
Find a file
saberzero1 3d5f3338fb
chore: commit dist/ and remove prepare script 
Pre-built output is now committed to the repository so that
Quartz can skip the build step during plugin installation.
The prepare script is removed to prevent redundant builds
when installing from npm/git.
2026-03-14 21:58:38 +01:00
.github/workflows Initial commit 2026-02-13 18:36:01 +01:00
dist chore: commit dist/ and remove prepare script 2026-03-14 21:58:38 +01:00
src deps: update @quartz-community/types and @quartz-community/utils 2026-03-09 03:04:02 +01:00
.eslintrc.json Initial commit 2026-02-13 18:36:01 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 21:58:38 +01:00
.prettierrc Initial commit 2026-02-13 18:36:01 +01:00
CHANGELOG.md Initial commit 2026-02-13 18:36:01 +01:00
LICENSE Initial commit 2026-02-13 18:36:01 +01:00
package-lock.json chore: commit dist/ and remove prepare script 2026-03-14 21:58:38 +01:00
package.json chore: commit dist/ and remove prepare script 2026-03-14 21:58:38 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:03 +01:00
tsconfig.json Initial commit 2026-02-13 18:36:01 +01:00
tsup.config.ts fix: compile SCSS via sass instead of raw text to prevent lightningcss errors 2026-02-26 16:44:51 +01: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,
});

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.

Documentation

See the Quartz documentation for more information.

License

MIT