From 2213424195b6ba761a6bf3343afca43b102d06b3 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Thu, 06 Mar 2025 02:34:02 +0000
Subject: [PATCH] docs: make role of getQuartzComponents more clear and also make it optional
---
quartz/plugins/types.ts | 7 ++++++-
1 files changed, 6 insertions(+), 1 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index 283a999..e7cfb47 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -39,7 +39,12 @@
export type QuartzEmitterPluginInstance = {
name: string
emit(ctx: BuildCtx, content: ProcessedContent[], resources: StaticResources): Promise<FilePath[]>
- getQuartzComponents(ctx: BuildCtx): QuartzComponent[]
+ /**
+ * Returns the components (if any) that are used in rendering the page.
+ * This helps Quartz optimize the page by only including necessary resources
+ * for components that are actually used.
+ */
+ getQuartzComponents?: (ctx: BuildCtx) => QuartzComponent[]
getDependencyGraph?(
ctx: BuildCtx,
content: ProcessedContent[],
--
Gitblit v1.10.0