plugin integration round 2

This commit is contained in:
Jacky Zhao 2023-05-30 08:02:20 -07:00
parent a757521313
commit ad6ce0d73f
29 changed files with 3863 additions and 100 deletions
quartz/plugins

38
quartz/plugins/types.ts Normal file
View file

@ -0,0 +1,38 @@
import { PluggableList } from "unified"
import { StaticResources } from "../resources"
import { ProcessedContent } from "./vfile"
export abstract class QuartzTransformerPlugin {
abstract name: string
abstract markdownPlugins(): PluggableList
abstract htmlPlugins(): PluggableList
externalResources?: Partial<StaticResources>
}
export abstract class QuartzFilterPlugin {
abstract name: string
abstract shouldPublish(content: ProcessedContent): boolean
}
export interface EmitOptions {
// meta
title: string
description: string
slug: string
ext: `.${string}`
// rendering related
content: string
}
export type EmitCallback = (data: EmitOptions) => Promise<void>
export abstract class QuartzEmitterPlugin {
abstract name: string
abstract emit(content: ProcessedContent[], emitCallback: EmitCallback): Promise<string[]>
}
export interface PluginTypes {
transformers: QuartzTransformerPlugin[],
filters: QuartzFilterPlugin[],
emitters: QuartzEmitterPlugin[],
}