From 2d6dc176c3e1fbb520a5da1beb60bbb1d8e948ba Mon Sep 17 00:00:00 2001
From: Pelayo Arbués <gonzalezpelayo@gmail.com>
Date: Thu, 31 Aug 2023 19:12:06 +0000
Subject: [PATCH] Adds Pelayo Arbues to showcase (#435)
---
quartz/plugins/types.ts | 45 ++++++++++++++++++++++++++++-----------------
1 files changed, 28 insertions(+), 17 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index 8c0d182..eaeb12a 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -1,41 +1,52 @@
import { PluggableList } from "unified"
-import { StaticResources } from "../resources"
+import { StaticResources } from "../util/resources"
import { ProcessedContent } from "./vfile"
-import { GlobalConfiguration } from "../cfg"
import { QuartzComponent } from "../components/types"
-import { FilePath, ServerSlug } from "../path"
+import { FilePath, FullSlug } from "../util/path"
+import { BuildCtx } from "../util/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
- markdownPlugins?: () => PluggableList
- htmlPlugins?: () => PluggableList
- externalResources?: () => Partial<StaticResources>
+ textTransform?: (ctx: BuildCtx, src: string | Buffer) => string | Buffer
+ markdownPlugins?: (ctx: BuildCtx) => PluggableList
+ htmlPlugins?: (ctx: BuildCtx) => PluggableList
+ externalResources?: (ctx: BuildCtx) => 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
+ shouldPublish(ctx: BuildCtx, 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<FilePath[]>
- getQuartzComponents(): QuartzComponent[]
+ emit(
+ ctx: BuildCtx,
+ content: ProcessedContent[],
+ resources: StaticResources,
+ emitCallback: EmitCallback,
+ ): Promise<FilePath[]>
+ getQuartzComponents(ctx: BuildCtx): QuartzComponent[]
}
export interface EmitOptions {
- slug: ServerSlug
+ slug: FullSlug
ext: `.${string}` | ""
content: string
}
--
Gitblit v1.10.0