diff --git a/docs/plugins/BasesPage.md b/docs/plugins/BasesPage.md index 37a8842..0b5d958 100644 --- a/docs/plugins/BasesPage.md +++ b/docs/plugins/BasesPage.md @@ -36,6 +36,7 @@ This plugin provides support for [Obsidian Bases](https://obsidian.md/changelog/ This plugin accepts the following configuration options: - `defaultViewType`: The default view type when none is specified in the `.base` file. Defaults to `"table"`. +- `linkResolution`: How to resolve internal links in view renderers. Should match the `markdownLinkResolution` setting of the [[CrawlLinks]] plugin. Can be `"absolute"`, `"relative"`, or `"shortest"`. Defaults to `"shortest"`. - `customViews`: A map of custom view renderers. Keys are view type names. These override built-in renderers for the same type, or add new view types. Requires a TS override. ### Default options diff --git a/docs/plugins/FolderPage.md b/docs/plugins/FolderPage.md index cc88fa8..d86ac4b 100644 --- a/docs/plugins/FolderPage.md +++ b/docs/plugins/FolderPage.md @@ -14,7 +14,9 @@ Example: [[advanced/|Advanced]] This plugin accepts the following configuration options: -- `sort`: A function of type `(f1: QuartzPluginData, f2: QuartzPluginData) => number{:ts}` used to sort entries. Defaults to sorting by date and tie-breaking on lexographical order. +- `showFolderCount`: Whether to display the number of pages in the folder. Defaults to `true`. +- `showSubfolders`: Whether to include pages from subfolders in the listing. Defaults to `true`. +- `sort`: A function of type `(f1: QuartzPluginData, f2: QuartzPluginData) => number{:ts}` used to sort entries. Defaults to sorting by date and tie-breaking on lexographical order. Requires a TS override. - `prefixFolders`: If `true`, generated folder page titles are prefixed with "Folder: " (e.g. "Folder: notes"). Defaults to `false`. ## API diff --git a/docs/plugins/Graph.md b/docs/plugins/Graph.md index 54b1e6f..0fe5d4f 100644 --- a/docs/plugins/Graph.md +++ b/docs/plugins/Graph.md @@ -24,16 +24,16 @@ Both `localGraph` and `globalGraph` accept the following options: - `drag`: Enable dragging nodes. Defaults to `true`. - `zoom`: Enable zooming. Defaults to `true`. - `depth`: The depth of the graph. Defaults to `1` for local and `-1` for global. -- `scale`: The initial scale of the graph. -- `repelForce`: The force that pushes nodes apart. -- `centerForce`: The force that pulls nodes to the center. -- `linkDistance`: The distance between linked nodes. -- `fontSize`: The font size of node labels. -- `opacityScale`: The scale of node opacity. -- `removeTags`: Tags to exclude from the graph. -- `showTags`: Whether to show tags in the graph. -- `enableRadial`: Whether to enable radial layout. -- `focusOnHover`: Whether to focus on the hovered node (global only). +- `scale`: The initial scale of the graph. Defaults to `1.1` for local and `0.9` for global. +- `repelForce`: The force that pushes nodes apart. Defaults to `0.5`. +- `centerForce`: The force that pulls nodes to the center. Defaults to `0.3` for local and `0.2` for global. +- `linkDistance`: The distance between linked nodes. Defaults to `30`. +- `fontSize`: The font size of node labels. Defaults to `0.6`. +- `opacityScale`: The scale of node opacity. Defaults to `1`. +- `removeTags`: Tags to exclude from the graph. Defaults to `[]`. +- `showTags`: Whether to show tags in the graph. Defaults to `true`. +- `enableRadial`: Whether to enable radial layout. Defaults to `false` for local and `true` for global. +- `focusOnHover`: Whether to focus on the hovered node. Defaults to `false` for local and `true` for global. ### Default options @@ -53,6 +53,7 @@ Both `localGraph` and `globalGraph` accept the following options: opacityScale: 1 removeTags: [] showTags: true + focusOnHover: false enableRadial: false globalGraph: drag: true diff --git a/docs/plugins/Search.md b/docs/plugins/Search.md index 7ffaaac..a814318 100644 --- a/docs/plugins/Search.md +++ b/docs/plugins/Search.md @@ -16,13 +16,20 @@ See [[full-text search]] for detailed usage information. This plugin accepts the following configuration options: -- `enabled`: Whether to enable full-text search. Defaults to `true`. +- `enablePreview`: Whether to show a preview of the page content in search results. Defaults to `true`. +- `fieldPriority`: An array specifying the priority order for search fields. Defaults to `["title", "content", "tags"]`. ### Default options ```yaml title="quartz.config.yaml" - source: github:quartz-community/search enabled: true + options: + enablePreview: true + fieldPriority: + - title + - content + - tags ``` ## API diff --git a/docs/plugins/TableOfContents.md b/docs/plugins/TableOfContents.md index 7584019..096f377 100644 --- a/docs/plugins/TableOfContents.md +++ b/docs/plugins/TableOfContents.md @@ -17,6 +17,7 @@ This plugin accepts the following configuration options: - `minEntries`: The minimum number of heading entries required for the TOC to be displayed. Default is `1`. - `showByDefault`: If `true` (default), the TOC should be displayed by default. Can be overridden by frontmatter settings. - `collapseByDefault`: If `true`, the TOC will start in a collapsed state. Default is `false`. +- `layout`: The visual layout of the TOC component. Can be `"modern"` or `"legacy"`. Default is `"modern"`. > [!warning] > This plugin needs the `Plugin.TableOfContents` component in `quartz.config.yaml` to determine where to display the TOC. Without it, nothing will be displayed. They should always be added or removed together. diff --git a/docs/plugins/TagPage.md b/docs/plugins/TagPage.md index b488dd6..c61bcdd 100644 --- a/docs/plugins/TagPage.md +++ b/docs/plugins/TagPage.md @@ -12,7 +12,8 @@ This plugin is a page type plugin that emits dedicated pages for each tag used i This plugin accepts the following configuration options: -- `sort`: A function of type `(f1: QuartzPluginData, f2: QuartzPluginData) => number{:ts}` used to sort entries. Defaults to sorting by date and tie-breaking on lexographical order. +- `numPages`: The maximum number of pages to display per tag before showing a "see more" link. Defaults to `10`. +- `sort`: A function of type `(f1: QuartzPluginData, f2: QuartzPluginData) => number{:ts}` used to sort entries. Defaults to sorting by date and tie-breaking on lexographical order. Requires a TS override. - `prefixTags`: If `true`, generated tag page titles are prefixed with "Tag: " (e.g. "Tag: recipes"). Defaults to `false`. ## API