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

docs: add prefixFolders option to configuration table

Browse source
This commit is contained in:
saberzero1 2026-03-18 17:47:01 +01:00
parent 0deda78145
commit 04c6101641
No known key found for this signature in database
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -24,16 +24,18 @@ 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. |
| 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