From 76c092dcf20959bc52fcb13b28cee50cd4217e40 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Thu, 20 Jul 2023 04:59:48 +0000
Subject: [PATCH] add custom.scss
---
quartz/plugins/types.ts | 52 +++++++++++++++++++++++++++++++---------------------
1 files changed, 31 insertions(+), 21 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index 80c70cb..8c0d182 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -1,33 +1,43 @@
import { PluggableList } from "unified"
import { StaticResources } from "../resources"
import { ProcessedContent } from "./vfile"
+import { GlobalConfiguration } from "../cfg"
+import { QuartzComponent } from "../components/types"
+import { FilePath, ServerSlug } from "../path"
-export abstract class QuartzTransformerPlugin {
- abstract name: string
- abstract markdownPlugins(): PluggableList
- abstract htmlPlugins(): PluggableList
- externalResources?: Partial<StaticResources>
+export interface PluginTypes {
+ transformers: QuartzTransformerPluginInstance[],
+ filters: QuartzFilterPluginInstance[],
+ emitters: QuartzEmitterPluginInstance[],
}
-export abstract class QuartzFilterPlugin {
- abstract name: string
- abstract shouldPublish(content: ProcessedContent): boolean
+type OptionType = object | undefined
+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>
+}
+
+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 QuartzEmitterPluginInstance = {
+ name: string
+ emit(contentDir: string, cfg: GlobalConfiguration, content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise<FilePath[]>
+ getQuartzComponents(): QuartzComponent[]
}
export interface EmitOptions {
- slug: string
- ext: `.${string}`
+ slug: ServerSlug
+ ext: `.${string}` | ""
content: string
}
-export type EmitCallback = (data: EmitOptions) => Promise<string>
-export abstract class QuartzEmitterPlugin {
- abstract name: string
- abstract emit(content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise<string[]>
-}
-
-export interface PluginTypes {
- transformers: QuartzTransformerPlugin[],
- filters: QuartzFilterPlugin[],
- emitters: QuartzEmitterPlugin[],
-}
+export type EmitCallback = (data: EmitOptions) => Promise<FilePath>
--
Gitblit v1.10.0