docs: fix incorrect plugin option defaults and phantom options
- 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:
@@ -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`.
|
||||
- `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.
|
||||
- `prettyLink`: whether to use pretty links for citations. Defaults to `true`.
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ This plugin accepts the following configuration options:
|
||||
**YAML options** (in `quartz.config.yaml`):
|
||||
|
||||
- `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`.
|
||||
- `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
|
||||
options:
|
||||
title: Explorer
|
||||
folderClickBehavior: collapse
|
||||
folderClickBehavior: link
|
||||
folderDefaultState: collapsed
|
||||
useSavedState: true
|
||||
```
|
||||
|
||||
@@ -17,9 +17,11 @@ See [[recent notes]] for detailed usage information.
|
||||
This plugin accepts the following configuration options:
|
||||
|
||||
- `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`.
|
||||
- `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
|
||||
|
||||
@@ -27,10 +29,10 @@ This plugin accepts the following configuration options:
|
||||
- source: github:quartz-community/recent-notes
|
||||
enabled: true
|
||||
options:
|
||||
title: Recent notes
|
||||
limit: 5
|
||||
limit: 3
|
||||
showTags: true
|
||||
linkToMore: ""
|
||||
hideTagPages: false
|
||||
hideFolderPages: false
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
@@ -27,11 +27,9 @@ Stacked pages are disabled on mobile by default (below 800px) since horizontal p
|
||||
|
||||
This plugin accepts the following configuration options:
|
||||
|
||||
- `paneWidth`: Width of each stacked pane in pixels. Defaults to `640`.
|
||||
- `maxPanes`: Maximum number of panes visible at once. Defaults to `5`.
|
||||
- `enableOnMobile`: Whether to enable stacked pages on mobile devices. Defaults to `false`.
|
||||
- `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`.
|
||||
- `maxTabs`: Maximum number of stacked panes visible at once. Defaults to `8`.
|
||||
- `mobileBreakpoint`: Viewport width (in pixels) below which stacked pages are disabled and links navigate normally. Defaults to `800`.
|
||||
- `showSpines`: Whether to show collapsed spine headers when panes overflow the viewport. Defaults to `true`.
|
||||
- `animateTransitions`: Whether to animate pane open/close transitions. Defaults to `true`.
|
||||
|
||||
### Default options
|
||||
@@ -44,9 +42,7 @@ This plugin accepts the following configuration options:
|
||||
priority: 50
|
||||
display: all
|
||||
options:
|
||||
paneWidth: 640
|
||||
maxPanes: 5
|
||||
enableOnMobile: false
|
||||
maxTabs: 8
|
||||
mobileBreakpoint: 800
|
||||
showSpines: true
|
||||
animateTransitions: true
|
||||
|
||||
Reference in New Issue
Block a user