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

fix: move ExternalPlugin overrides before loadQuartzConfig in quartz.ts docs

Browse Source 
loadQuartzConfig() internally calls loadQuartzLayout() to build the
PageTypeDispatcher, which instantiates components. Plugin option overrides
must be registered before this happens. Updated quartz.ts and all doc
snippets that show the ExternalPlugin override pattern to place calls
before loadQuartzConfig(). Also updated OxHugo and Roam docs from stale
v4 plugins pattern to v5 override pattern.
This commit is contained in:
saberzero1
2026-05-24 18:32:05 +02:00
parent d45b7a7bf6
commit ed0f27c05f
8 changed files with 22 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/advanced/making plugins.md
View File

@@ -696,15 +696,15 @@ For options that require JavaScript callback functions (not expressible in YAML)
```ts title="quartz.ts (override)"
import * as ExternalPlugin from "./.quartz/plugins"
// Must be placed before loadQuartzConfig()
ExternalPlugin.MyPlugin({
// callback functions or other non-serializable options
customFn: (data) => {
// ...
},
})
```
Options set via `quartz.ts` are merged with YAML options at instantiation time, with `quartz.ts` overrides taking precedence.
Options set via `quartz.ts` are merged with YAML options at instantiation time, with `quartz.ts` overrides taking precedence. These calls must be placed **before** `loadQuartzConfig()` in your `quartz.ts`.
### Development Workflow