zaine/quartz
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix incorrect plugin option defaults and phantom options

Browse Source 
- Citations: remove non-existent prettyLink option
- Explorer: correct folderClickBehavior default from collapse to link
- RecentNotes: fix limit default from 5 to 3, add hideTagPages/hideFolderPages
- StackedPages: fix option names to match source (maxTabs, not maxPanes)
This commit is contained in:
saberzero1
2026-05-22 20:07:47 +02:00
parent c6d7da00b2
commit bc1c6a47d8
4 changed files with 13 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/plugins/Citations.md
View File

@@ -16,7 +16,6 @@ This plugin accepts the following configuration options:
- `suppressBibliography`: whether to suppress the bibliography at the end of the document. Defaults to `false`. - `suppressBibliography`: whether to suppress the bibliography at the end of the document. Defaults to `false`.
- `linkCitations`: whether to link citations to the bibliography. Defaults to `false`. - `linkCitations`: whether to link citations to the bibliography. Defaults to `false`.
- `csl`: the citation style to use. Defaults to `apa`. Reference [rehype-citation](https://rehype-citation.netlify.app/custom-csl) for more options. - `csl`: the citation style to use. Defaults to `apa`. Reference [rehype-citation](https://rehype-citation.netlify.app/custom-csl) for more options.
- `prettyLink`: whether to use pretty links for citations. Defaults to `true`.
## API ## API

4
docs/plugins/Explorer.md
View File

@@ -19,7 +19,7 @@ This plugin accepts the following configuration options:
**YAML options** (in `quartz.config.yaml`): **YAML options** (in `quartz.config.yaml`):
- `title`: The title of the explorer. Defaults to `Explorer`. - `title`: The title of the explorer. Defaults to `Explorer`.
- `folderClickBehavior`: The behavior when a folder is clicked. Can be `"link"` to navigate or `"collapse"` to toggle. Defaults to `collapse`. - `folderClickBehavior`: The behavior when a folder is clicked. Can be `"link"` to navigate or `"collapse"` to toggle. Defaults to `link`.
- `folderDefaultState`: The default state of folders. Can be `"collapsed"` or `"open"`. Defaults to `collapsed`. - `folderDefaultState`: The default state of folders. Can be `"collapsed"` or `"open"`. Defaults to `collapsed`.
- `useSavedState`: Whether to use local storage to save the state of the explorer. Defaults to `true`. - `useSavedState`: Whether to use local storage to save the state of the explorer. Defaults to `true`.
@@ -37,7 +37,7 @@ This plugin accepts the following configuration options:
enabled: true enabled: true
options: options:
title: Explorer title: Explorer
folderClickBehavior: collapse folderClickBehavior: link
folderDefaultState: collapsed folderDefaultState: collapsed
useSavedState: true useSavedState: true
``` ```

12
docs/plugins/RecentNotes.md
View File

@@ -17,9 +17,11 @@ See [[recent notes]] for detailed usage information.
This plugin accepts the following configuration options: This plugin accepts the following configuration options:
- `title`: The title of the recent notes section. Defaults to `Recent notes`. - `title`: The title of the recent notes section. Defaults to `Recent notes`.
- `limit`: The maximum number of recent notes to display. Defaults to `5`. - `limit`: The maximum number of recent notes to display. Defaults to `3`.
- `showTags`: Whether to display the tags for each note. Defaults to `true`. - `showTags`: Whether to display the tags for each note. Defaults to `true`.
- `linkToMore`: A slug to a page that shows more notes. Defaults to `""`. - `linkToMore`: A slug to a page that shows more notes. Defaults to `false`.
- `hideTagPages`: Whether to hide tag index pages from the list. Defaults to `false`.
- `hideFolderPages`: Whether to hide folder index pages from the list. Defaults to `false`.
### Default options ### Default options
@@ -27,10 +29,10 @@ This plugin accepts the following configuration options:
- source: github:quartz-community/recent-notes - source: github:quartz-community/recent-notes
enabled: true enabled: true
options: options:
title: Recent notes limit: 3
limit: 5
showTags: true showTags: true
linkToMore: "" hideTagPages: false
hideFolderPages: false
``` ```
## API ## API

12
docs/plugins/StackedPages.md
View File

@@ -27,11 +27,9 @@ Stacked pages are disabled on mobile by default (below 800px) since horizontal p
This plugin accepts the following configuration options: This plugin accepts the following configuration options:
- `paneWidth`: Width of each stacked pane in pixels. Defaults to `640`. - `maxTabs`: Maximum number of stacked panes visible at once. Defaults to `8`.
- `maxPanes`: Maximum number of panes visible at once. Defaults to `5`. - `mobileBreakpoint`: Viewport width (in pixels) below which stacked pages are disabled and links navigate normally. Defaults to `800`.
- `enableOnMobile`: Whether to enable stacked pages on mobile devices. Defaults to `false`. - `showSpines`: Whether to show collapsed spine headers when panes overflow the viewport. Defaults to `true`.
- `mobileBreakpoint`: Viewport width (in pixels) below which the mobile behavior applies. Matches the Quartz mobile breakpoint. Defaults to `800`.
- `showSpines`: Whether to show collapsed spine headers when panes overflow. Defaults to `true`.
- `animateTransitions`: Whether to animate pane open/close transitions. Defaults to `true`. - `animateTransitions`: Whether to animate pane open/close transitions. Defaults to `true`.
### Default options ### Default options
@@ -44,9 +42,7 @@ This plugin accepts the following configuration options:
priority: 50 priority: 50
display: all display: all
options: options:
paneWidth: 640 maxTabs: 8
maxPanes: 5
enableOnMobile: false
mobileBreakpoint: 800 mobileBreakpoint: 800
showSpines: true showSpines: true
animateTransitions: true animateTransitions: true