From 8fd75ffbfda30edd5a134a1fbf9b81ac3cebb2ff Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 24 Jul 2023 00:42:00 +0000
Subject: [PATCH] support attachments folder
---
quartz/plugins/types.ts | 31 ++++++++++++++++++++++---------
1 files changed, 22 insertions(+), 9 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index f74b3c9..4145e8f 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -3,15 +3,19 @@
import { ProcessedContent } from "./vfile"
import { GlobalConfiguration } from "../cfg"
import { QuartzComponent } from "../components/types"
+import { FilePath, ServerSlug } from "../path"
+import { BuildCtx } from "../ctx"
export interface PluginTypes {
- transformers: QuartzTransformerPluginInstance[],
- filters: QuartzFilterPluginInstance[],
- emitters: QuartzEmitterPluginInstance[],
+ transformers: QuartzTransformerPluginInstance[]
+ filters: QuartzFilterPluginInstance[]
+ emitters: QuartzEmitterPluginInstance[]
}
type OptionType = object | undefined
-export type QuartzTransformerPlugin<Options extends OptionType = undefined> = (opts?: Options) => QuartzTransformerPluginInstance
+export type QuartzTransformerPlugin<Options extends OptionType = undefined> = (
+ opts?: Options,
+) => QuartzTransformerPluginInstance
export type QuartzTransformerPluginInstance = {
name: string
textTransform?: (src: string | Buffer) => string | Buffer
@@ -20,23 +24,32 @@
externalResources?: () => Partial<StaticResources>
}
-export type QuartzFilterPlugin<Options extends OptionType = undefined> = (opts?: Options) => QuartzFilterPluginInstance
+export type QuartzFilterPlugin<Options extends OptionType = undefined> = (
+ opts?: Options,
+) => QuartzFilterPluginInstance
export type QuartzFilterPluginInstance = {
name: string
shouldPublish(content: ProcessedContent): boolean
}
-export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (opts?: Options) => QuartzEmitterPluginInstance
+export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
+ opts?: Options,
+) => QuartzEmitterPluginInstance
export type QuartzEmitterPluginInstance = {
name: string
- emit(contentDir: string, cfg: GlobalConfiguration, content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise<string[]>
+ emit(
+ ctx: BuildCtx,
+ content: ProcessedContent[],
+ resources: StaticResources,
+ emitCallback: EmitCallback,
+ ): Promise<FilePath[]>
getQuartzComponents(): QuartzComponent[]
}
export interface EmitOptions {
- slug: string
+ slug: ServerSlug
ext: `.${string}` | ""
content: string
}
-export type EmitCallback = (data: EmitOptions) => Promise<string>
+export type EmitCallback = (data: EmitOptions) => Promise<FilePath>
--
Gitblit v1.10.0