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

docs: added documentation on init() for component plugins

Browse Source
This commit is contained in:
saberzero1
2026-03-16 14:31:16 +01:00
parent 4bb075cc64
commit 24634934d1
2 changed files with 33 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/advanced/making plugins.md
View File

@@ -536,3 +536,5 @@ npx quartz plugin prune --dry-run
## Component Plugins
For plugins that provide visual components (like Explorer, Graph, Search), see the [[creating components|creating component plugins]] guide.
Component-only plugins (those with `"category": ["component"]` in their manifest) are loaded via side-effect import rather than a factory function. If your component-only plugin needs to receive user options from `quartz.config.yaml`, export an `init(options)` function — see [[creating components#Receiving YAML Options in Component-Only Plugins|receiving YAML options]] for details.